XBee Cellular topic
- Introduction
- Manufacturer Documentation
- Modem Constructor
- Example Code
- Reference
-
Detailed Descriptions
Introduction
**_All_** Digi cellular modems can be implented as a DigiXBeeCellularTransparent object - a subclass of DigiXBee and loggerModem. The "transparent" refers to the Digi name for the operating mode of the module. It is transparent in that data received by the module on the serial interface is output directly the connected client - the module becomes transparent allowing data to pass right through.
The power requirements for the cellular XBee's depend on the specific module. The 3G module must have 2 amps of power available. Most of the others can get by with ~1amp (which is still 2x what a standard USB port of Arduino board can provide.) The LTE-M module can just about almost get by on 500mA, but it definitely not ideal.
Manufacturer Documentation
The Digi product page for the various cellular modules is here: https:/
Modem Constructor
Construct a new Digi XBee Cellular Transparent object. The constuctor initializes all of the provided member variables, constructs a loggerModem parent class with the appropriate timing for the module, calls the constructor for a TinyGSM modem on the provided modemStream, and creates a TinyGSM Client linked to the modem. Should be set to a negative number if the modem should be continuously powered or the power cannot be controlled by the MCU.
Should be set to a negative number if the modem status pin cannot be read. This can be either the pin named
DigiXBeeCellularTransparent::
Parameters
modemStream
The Arduino stream instance for serial communication.
powerPin
The digital pin number of the mcu pin controlling power to the modem (active
HIGH
).
statusPin
The digital pin number of the mcu pin connected to the modem status output pin.
useCTSStatus
True to use the
CTS_N/DIO7
pin of the XBee as a status indicator rather than the true status (ON/SLEEP_N/DIO9
) pin. This inverts the loggerModem::
modemResetPin
The digital pin number of the pin on the mcu attached the the hard or panic reset pin of the modem.
modemSleepRqPin
The digital pin number of a pin on the mcu used to request the modem enter its lowest possible power state.
apn
The Access Point Name (APN) for the SIM card.
user
The user name, if required, associated with the APN; optional, defaulting to NULL
pwd
The password, if required, associated with the APN; optional, defaulting to NULL
ON/SLEEP_N/DIO9
or CTS_N/DIO7
pin in Digi's hardware reference.
Should be set to a negative number if the modem reset pin is not connected to the MCU. This shold be the pin called RESET_N
in Digi's hardware reference.
Should be set to a negative number if there is no pin usable for deep sleep modes or it is not accessible to the MCU. This shold be the pin called DTR_N/SLEEP_RQ/DIO8
in Digi's hardware reference.
Example Code
Creating the Modem Object
A transparent-mode Digi cellular module is used in the menu a la carte example.
LTE Network Selection
For LTE boards, it is good practice to select which network you'll be connecting to based on your SIM card and signal availability. Example code for this can also be found in the menulink{setup_xbeec_carrier} example.
Classes
- class DigiXBeeCellularTransparent
- The class for any of Digi Cellular XBee or XBee3 modules operating in Digi's "transparent" mode.