xbee_at_cmds.h File Reference

Header file for XBee AT commands. More...

#include <stdint.h>

Include dependency graph for xbee_at_cmds.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	at_command_t {   AT_ , AT_CN , AT_AP , AT_BD ,   AT_WR , AT_RE , AT_VR , AT_AC ,   AT_NR , AT_DD , AT_ID , AT_NI ,   AT_DL , AT_DH , AT_SH , AT_SL ,   AT_PL , AT_AI , AT_RP , AT_RN ,   AT_RR , AT_ND , AT_NO , AT_RO ,   AT_SM , AT_SO , AT_SP , AT_ST ,   AT_IS , AT_P0 , AT_P1 , AT_P2 ,   AT_P3 , AT_P4 , AT_P5 , AT_P6 ,   AT_P7 , AT_P8 , AT_PR , AT_RI ,   AT_CT , AT_GT , AT_SB , AT_D7 ,   AT_D8 , AT_D9 , AT_DA , AT_DB ,   AT_DC , AT_FT , AT_GU , AT_HS ,   AT_IT , AT_NJ , AT_JN , AT_JT ,   AT_JV , AT_LD , AT_AO , AT_CE ,   AT_SE , AT_DE_RF , AT_CI , AT_BH ,   AT_YS , AT_WR_RF , AT_IP , AT_MA ,   AT_OK , AT_RI_CELL , AT_SR , AT_TD ,   AT_TR , AT_TS , AT_UK , AT_VE ,   AT_VL , AT_DE , AT_AK , AT_AE ,   AT_NK , AT_JS , AT_LC , AT_AM ,   AT_AD , AT_DR , AT_LR , AT_LV ,   AT_J1 , AT_J2 , AT_D1 , AT_D2 ,   AT_XD , AT_XF , AT_PO , AT_CM }
	Enumeration of common and module-specific XBee AT commands. More...

Functions
const char *	atCommandToString (at_command_t command)
	Converts an AT command enum to its corresponding string representation. More...

Detailed Description

Header file for XBee AT commands.

This file defines the interface for working with XBee AT commands. AT commands are used for configuring and controlling the XBee module.

Version

1.0

Date

2024-08-08

@license MIT Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Author

Felix Galindo @contact felix.nosp@m..gal.nosp@m.indo@.nosp@m.digi.nosp@m..com

Enumeration Type Documentation

at_command_t

enum at_command_t

Enumeration of common and module-specific XBee AT commands.

This enum defines the AT commands supported by various XBee modules. Each command corresponds to a specific configuration or control operation within the module.

AT commands allow users to configure the XBee module, control its behavior, and query various parameters such as network status, signal strength, and device settings.

Enumerator
AT_	XBee Common AT Commands Placeholder for unspecified commands
AT_CN	Exit Command Mode
AT_AP	API Enable
AT_BD	Baud Rate
AT_WR	Write to non-volatile memory
AT_RE	Restore factory defaults
AT_VR	Firmware Version
AT_AC	Apply Changes
AT_NR	Network Reset
AT_DD	Device Type Identifier
AT_ID	PAN ID
AT_NI	Node Identifier
AT_DL	Destination Address Low
AT_DH	Destination Address High
AT_SH	Serial Number High
AT_SL	Serial Number Low
AT_PL	Power Level
AT_AI	Association Indication
AT_RP	RSSI PWM Timer
AT_RN	Random Delay Slots
AT_RR	Retries
AT_ND	Node Discover
AT_NO	Network Discovery Options
AT_RO	Packetization Timeout
AT_SM	Sleep Mode
AT_SO	Sleep Options
AT_SP	Sleep Period
AT_ST	Time Before Sleep
AT_IS	Force Sample (IO)
AT_P0	DIO0/AD0 Configuration
AT_P1	DIO1/AD1 Configuration
AT_P2	DIO2/AD2 Configuration
AT_P3	DIO3/AD3 Configuration
AT_P4	DIO4 Configuration
AT_P5	DIO5 Configuration
AT_P6	DIO6 Configuration
AT_P7	DIO7 Configuration
AT_P8	DIO8 Configuration
AT_PR	Pull-up Resistor Enable
AT_RI	Ring Indicator
AT_CT	Command Mode Timeout
AT_GT	Guard Times
AT_SB	Stop Bits
AT_D7	DIO7 Configuration
AT_D8	DIO8 Configuration
AT_D9	DIO9 Configuration
AT_DA	DIO10 Configuration
AT_DB	RSSI for Last Hop
AT_DC	DIO Change Detect
AT_FT	Flow Control Threshold
AT_GU	DIO Pull-up Resistor Enable
AT_HS	Hardware Sleep Control
AT_IT	RSSI Timer
AT_NJ	Node Join Time
AT_JN	Join Notification
AT_JT	Join Time
AT_JV	Channel Verification
AT_LD	Node Discovery Time
AT_AO	API Options XBee 3 RF Specific AT Commands
AT_CE	Coordinator Enable
AT_SE	Source Endpoint
AT_DE_RF	Destination Endpoint (RF specific)
AT_CI	Cluster Identifier
AT_BH	Broadcast Hops
AT_YS	Sleep Status
AT_WR_RF	Write to non-volatile memory (RF specific) XBee 3 Cellular Specific AT Commands
AT_IP	IP Address
AT_MA	MAC Address
AT_OK	Cellular OK Command
AT_RI_CELL	Ring Indicator (Cellular Specific)
AT_SR	Serial Number
AT_TD	Transmit Delay
AT_TR	Transmission Retry Count
AT_TS	Transmission Status
AT_UK	Unlock Password
AT_VE	Voltage Supply
AT_VL	Cellular Module Version XBee LR Specific AT Commands
AT_DE	LoRaWAN Device EUI
AT_AK	LoRaWAN Application Key
AT_AE	LoRaWAN Application EUI
AT_NK	LoRaWAN Network Key
AT_JS	LoRaWAN Join Status
AT_LC	LoRaWAN Class
AT_AM	LoRaWAN Activation Mode
AT_AD	LoRaWAN ADR
AT_DR	LoRaWAN DataRate
AT_LR	LoRaWAN Region
AT_LV	LoRaWAN Spec Version
AT_J1	LoRaWAN Join RX1 Delay
AT_J2	LoRaWAN Join RX2 Delay
AT_D1	LoRaWAN RX1 Delay
AT_D2	LoRaWAN RX2 Delay
AT_XD	LoRaWAN RX2 Data Rate
AT_XF	LoRaWAN RX2 Frequency
AT_PO	LoRaWAN Transmit Power
AT_CM	LoRaWAN Channels Mask

Function Documentation

atCommandToString()

const char * atCommandToString

(

at_command_t

command

)

Converts an AT command enum to its corresponding string representation.

This function takes an AT command enum and returns the corresponding string representation that can be sent to the XBee module.

Parameters

command

The AT command enum to convert.

Returns

const char* The string representation of the AT command.

Converts an AT command enum to its corresponding string representation.

This function takes an AT command enum value and returns the corresponding string representation of the command.

Parameters

[in]

command

The AT command enum value.

Returns

The string representation of the AT command.

< XBee Common AT Commands

< Placeholder for unspecified commands

< Exit Command Mode

< API Enable

< Baud Rate

< Write to non-volatile memory

< Restore factory defaults

< Firmware Version

< Apply Changes

< Network Reset

< Device Type Identifier

< PAN ID

< Node Identifier

< Destination Address Low

< Destination Address High

< Serial Number High

< Serial Number Low

< Power Level

< Association Indication

< RSSI PWM Timer

< Random Delay Slots

< Retries

< Node Discover

< Network Discovery Options

< Packetization Timeout

< Sleep Mode

< Sleep Options

< Sleep Period

< Time Before Sleep

< Force Sample (IO)

< DIO0/AD0 Configuration

< DIO1/AD1 Configuration

< DIO2/AD2 Configuration

< DIO3/AD3 Configuration

< DIO4 Configuration

< DIO5 Configuration

< DIO6 Configuration

< DIO7 Configuration

< DIO8 Configuration

< Pull-up Resistor Enable

< Ring Indicator

< Command Mode Timeout

< Guard Times

< Stop Bits

< DIO7 Configuration

< DIO8 Configuration

< DIO9 Configuration

< DIO10 Configuration

< RSSI for Last Hop

< DIO Change Detect

< Flow Control Threshold

< DIO Pull-up Resistor Enable

< Hardware Sleep Control

< RSSI Timer

< Node Join Time

< Join Notification

< Join Time

< Channel Verification

< Node Discovery Time

< API Options

< XBee 3 RF Specific AT Commands

< Coordinator Enable

< Source Endpoint

< Destination Endpoint (RF specific)

< Cluster Identifier

< Broadcast Hops

< Sleep Status

< Write to non-volatile memory (RF specific)

< XBee 3 Cellular Specific AT Commands

< IP Address

< MAC Address

< Cellular OK Command

< Ring Indicator (Cellular Specific)

< Serial Number

< Transmit Delay

< Transmission Retry Count

< Transmission Status

< Unlock Password

< Voltage Supply

< Cellular Module Version

< XBee LR Specific AT Commands

< LoRaWAN Device EUI

< LoRaWAN Application Key

< LoRaWAN Application EUI

< LoRaWAN Network Key

< LoRaWAN Join Status

< LoRaWAN Class

< LoRaWAN Activation Mode

< LoRaWAN ADR

< LoRaWAN DataRate

< LoRaWAN Region

< LoRaWAN Spec Version

< LoRaWAN Join RX1 Delay

< LoRaWAN Join RX2 Delay

< LoRaWAN RX1 Delay

< LoRaWAN RX2 Delay

< LoRaWAN RX2 Data Rate

< LoRaWAN RX2 Frequency

< LoRaWAN Transmit Power

< LoRaWAN Channels Mask

< Unknown command