Diff: doc/mDot-AT-commands.txt

Revision:

6:e27eaad36a0c

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/mDot-AT-commands.txt	Fri Jan 29 14:01:05 2016 -0600
@@ -0,0 +1,106 @@
+# vim: expandtab sts=8 sw=8 ts=8
+Command         Name                            Description
+
+General commands
+----------------
+Command         Name                    Description
+
+AT              Attention               Attention
+ATI             Request Id              Request Identification
+ATZ             Reset CPU               Reset the CPU
+ATE0/1          Enable/Disable Echo     ATE0: disable, ATE1: enable
+ATV0/1          Enable/Disable Verbose  ATV0: disable, ATV1: enable
+AT&F            Reset Factory Defaults  Reset current configuration to factory defaults
+AT&W            Save Configuration      Save configuration to flash memory
+AT&V            Display Settings        Displays current settings and status
+AT&S            Display Stats           Display statistics
+AT&R            Reset Stats             Reset statistics
+AT+IPR          Serial Baud Rate        Set serial baud rate, default: 115200 
+AT+DIPR         Debug Baud Rate         Set debug serial baud rate, default: 115200 
+AT+SMODE        Start Up Mode           0: AT command mode, 1: Serial data mode
+AT+LOG			Debug Log Level			Enable/disable debug logging. (0: off, 1:Fatal - 6:Trace)
+
+Network/Addressing commands
+---------------------------
+
+AT+FREQ         Frequency Band          Configured Frequency Band '868' or '915'
+AT+FSB          Frequency Sub-band      Set the frequency sub-band for US 915, (0:ALL, 1-8)
+AT+PN           Public Network          Enable/disable public network mode. (0: off, 1: on)
+AT+DI           Device ID               Device EUI (unique, set at factory) (8 bytes)
+AT+NA           Network Address         Network address (devAddr in LoraMac) (4 bytes)
+AT+NSK          Network Session Key     Network session encryption key (16 bytes)
+AT+DSK          Data Session Key        Data session encryption key (16 bytes)
+AT+NK           Network Key             Configured network key/passphrase (App Key in LoraMac) ##  AT+NK=0,hex  AT+NK=1,passphrase (Net key = cmac(passphrase)) (16 bytes)
+AT+NI           Network ID              Configured Network EUI/Name (App EUI in LoraMac) AT+NI=0,hex AT+NI=1,network_name  (Net ID = crc64(network_name)) (8 bytes)
+AT+JOIN         Join Network            Join network (acquire network address and session keys)
+AT+JR			Join Retries			Number of times to retry joining the network in an attempt (0 - 255)
+AT+JBO			Join Byte Order			Send EUI's in join request with configured byte ordering 
+AT+NJM          Network Join Mode       0: Manual configuration, 1: OTA Network Join, 2: Auto OTA Network Join on start up (default: 1)
+AT+NJS          Network Join Status     0: Not joined, 1: Joined
+AT+NLC          Network Link Check      Perform network link check, displays dBm above floor, number of gateways in range and optional packet payload if received
+AT+LCC          Link Check Count        Set number of packets between each link check if ACK's are disabled
+AT+LCT          Link Check Threshold    Set threshold for number of link check of ACK failures to tolerate, (0: off, N: number of failures)
+AT+ENC          AES Encryption          Enable/disable AES encryption (0: off, 1: on)
+AT+RSSI         Signal Strength         Displays signal strength of received packets, last,min,max,avg
+AT+SNR          Signal To Noise Ratio   Display signal to noise ratio received packets last,min,max,avg
+AT+DP           Data Pending            Indicator of data in queue on server
+AT+PING         Send Ping               Sends ping, displays RSSI and SNR from gateway on pong
+
+Radio Configuration
+-------------------
+
+AT+TXDR         Tx Data Rate            Set the Tx data rate for all channels
+AT+TXP          Tx Power                Set the Tx power for all channels
+AT+TXF          Tx Frequency            Set Tx frequency
+AT+TXI          Set Tx inverted         Set Tx signal inverted, (default:off)
+AT+TXW          Tx Wait                 Enable/disable waiting for rx windows to expire after send. (0: off, 1: on)
+AT+TXCH         Tx Channels             List Tx channel frequencies for sub-band
+AT+RXDR         Rx Data Rate            Set the Rx data rate
+AT+RXF          Rx Frequency            Set the Rx frequency for +RECV,+RECVC
+AT+RXO          Rx Output               Set the Rx output type (0:hexadecimal, 1:raw)
+AT+RXI          Set Rx inverted         Set Rx signal inverted, (default:on)
+AT+FEC          Error Correction        Configure Forward Error Correction bytes (1 to 4)
+AT+CRC          CRC Checking            Enable/disable CRC checking of received packets. (0: off, 1: on)
+AT+ADR          Adaptive Data Rate      Enable/disable Adaptive Data Rate (0: off, 1: on)
+
+
+Send/Receive
+------------
+
+AT+ACK          Require ACK             Enable to require send acknowledgment (0: off, N: number of retries until ACK recevied)
+AT+SEND         Send Once               Sends supplied packet data one time and return response, (max:240 bytes)
+AT+SENDH        Send Once High BW       Sends supplied packet data one time and return response using High Bandwidth channel, (max:240 bytes)
+AT+SENDB        Send Binary             Sends supplied binary (hex) packet data one time and return response
+AT+SENDI        Send Continuous         Sends supplied packet data on interval between sends, output any received packets (escape sequence: +++)
+AT+RECV         Receive Once            Display last received packet
+AT+RECVC        Receive Continuous      Continuously receive and display packets, optional timeout in ms overrides configured Rx Timeout. (escape sequence: +++)
+AT+TXN			Tx Next					Get time in ms until next free channel
+AT+TOA          Time on air             Get time in ms of packet tx with current datarate
+
+
+Sleep/Serial data mode options
+------------------------
+
+AT+SD           Serial Data Mode        Reads serial data, sends Lora packets, then sleeps
+AT+SLEEP        Sleep Mode              Put mDot into sleep mode, (0:stop,1:standby)
+AT+WM           Wake Mode               Wakeup mode (0:INTERVAL,1:INTERRUPT)
+AT+WI           Wake Interval           Wakeup interval (seconds)
+AT+WP           Wake Pin                Wakeup DIO pin of sleep mode (default: DI8), deep-sleep uses DIO7
+AT+WD           Wake Delay              Time to wait for data after wakeup signal  (milliseconds)
+AT+WTO          Wake Timeout            Read serial data until timeout (milliseconds)
+
+
+MultiTech Debug
+---------------
+AT+SENDC        Send Continuous         Send un-modulated data continuously
+AT+DREGS        Dump Regs               Dump the SX1272 register values
+AT+ERASE        Erase entire flash      Erase all configurations saved in flash memory
+AT&WP           Write Protected Config  Write protected config to flash (DeviceId and Frequency Band)
+
+
+Possible Future commands
+------------------------
+AT+DIO0         Read/write DIO pins (conform to Xbee?)
+AT+AD0          Read analog input pins
+AT+SRS          Serial receive size             Read N bytes at a time for serial data mode
+Peer to Peer mode