AX−SFUS, AX−SFUS−API
www.onsemi.com
11
COMMAND INTERFACE
General Information
The chapter “Command Interface” is a documentation of
the AT−Command set for devices which do not have an
API−interface. To see whether the device is capable of
receiving AT−Commands, please refer to chapter “Part
Numbers”. If the device has been shipped with the
API−Interface, please refer to the SW manual and
“apiexample” code delivered with AX−SF−LIB−1−GEVK
for an introduction on how to setup a project and how to use
the API−Interface.
Serial Parameters: 9600, 8, N, 1
The AX−SFUS uses the UART (pins UARTTX,
UARTRX) to communicate with a host and uses a bitrate of
9600 baud, no parity, 8 data bits and one stop bit.
Power Modes
Standby
After Power−Up and after finishing a SIGFOX
transmission, AX−SFUS enters Standby mode. In Standby
mode, AX−SFUS listens on the UART for commands from
the host. Also, OOB frames are transmitted whenever the
OOB timer fires. To conserve power, the AX−SFUS can be
put into Sleep or turned off (Deep Sleep) completely.
Sleep
The command AT$P=1 is used to put the AX−SFUS into
Sleep mode. In this mode, only the wakeup timer for
out−of−band messages is still running. To wake the
AX−SFUS up from Sleep mode toggle the serial UARTRX
pin, e.g. by sending a break (break is an RS232 framing
violation, i.e. at least 10 bit durations low). When an Out of
Band (OOB) message is due, AX−SFUS automatically
wakes up to transmit the message, and then returns to Sleep
mode.
Deep Sleep
In Deep Sleep mode, the AX−Sigfox is completely turned
off and only draws negligible leakage current. Deep Sleep
mode can be activated with AT$P=2. To wake−up from
Deep Sleep mode, GPIO9 is pulled to GND.
When using Deep Sleep mode, keep two things in mind:
Everything is turned off, timers are not running at all and all
settings will be lost (use AT$WR to save settings to flash
before entering Deep Sleep mode). Out−of−band messages
will therefore not be sent. The pins states are frozen in Deep
Sleep mode. The user must ensure that this will not result in
condition which would draw a lot of current.
AT Commands
Numerical Syntax
hexdigit ::= [0−9A−Fa−f]
hexnum ::= “0x” hexdigit+
decnum ::= “0” | [1−9] [0−9]*
octnum ::= “0” [0−7]+
binnum ::= “0b” [01]+
bit ::= [01]
optnum ::= “−1”
frame ::= (hexdigit hexdigit)+
uint ::= hexnum | decnum | octnum | binnum
uint_opt ::= uint | optnum
Command Syntax
A command starts with ‘AT’ (everything is case
sensitive!), continues with the actual command followed by
parameters (if any) and ends with any kind of whitespace
(space, tab, newline etc.)
If incorrect syntax is detected (“parsing error”) all input
is ignored up until the next whitespace character.
Also note that any number can be entered in any format
(Hexadecimal, Decimal, Octal and binary) by adding the
corresponding prefix (‘0x’, ‘0’, ‘0b’). The only exception is
the ‘Send Frame’ command (AT$SF) which expects a list of
hexadecimal digits without any prefix.
Return Codes
A successful command execution is indicated by sending
‘OK’. If a command returns a value (e.g. by querying a
register) only the value is returned.
Examples
Bold text is sent to AX−SFUS.
AT$I=0
AXSEM AT Command Interface
Here, we execute command ‘I’ to query some general
information.
AT$SF=aabb1234
OK
This sends a Sigfox frame containing { 0x00 : 0x11 : 0x22
: 0x33 : 0x44 }, then waits for a downlink response telegram,
which in this example contains { 0xAA : 0xBB : 0xCC :
0xDD }.
