XBee Wifi S6B topic
- Introduction
- Manufacturer Documentation
- Modem Constructor
- Example Code
- Reference
- Detailed Descriptions
Introduction
Digi's wifi XBee is implemented as a DigiXBeeWifi object - a subclass of DigiXBee and loggerModem. The S6B is run in Digi's "transparent" mode. The maxiumum power draw is ~300mA.
Manufacturer Documentation
The Digi product page for the S6B wifi module is here: https:/
Modem Constructor
Construct a new Digi XBee Wifi 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
DigiXBeeWifi::
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.
ssid
The wifi network ID.
pwd
The wifi network password, assuming WPA2.
maintainAssociation
Whether to maintain association with the access point during sleep. Maitaining the association during sleep draws more current (+10mA?), but also allows a faster reconnection on the next wake.
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
The digi_cellular is used in the menu a la carte example.
Classes
- class DigiXBeeWifi
- The class for the Digi XBee S6B wifi module operating in Digi's "transparent" mode.
Configuration Defines
Defines to configure if and when to reset the WiFi XBee
- #define XBEE_RESET_THRESHOLD = 4
- This causes the WiFi XBee to reset after this number of transmission attempts.
Define documentation
#define XBEE_RESET_THRESHOLD = 4
#include <src/modems/DigiXBeeWifi.h>
This causes the WiFi XBee to reset after this number of transmission attempts.