Api operation, Api frame specifications – B&B Electronics ZP9D-115RM-LR - Manual User Manual
Page 51

Manual Documentation Number: ZP9D-115RM-LR-0812
51
B&B Electronics Mfg Co Inc – 707 Dayton Rd - PO Box 1040 - Ottawa IL 61350 - Ph 815-433-5100 - Fax 815-433-5104 – www.bb-elec.com
B&B Electronics – Westlink Commercial Park – Oranmore, Galway, Ireland – Ph +353 91-792444 – Fax +353 91-792445 – www.bb-europe.com
WR (Write) Command
<(Special)> The WR
command is used to write
configurable parameters to non-volatile memory (Values remain in the module's
memory until overwritten by another use of WR Command).
If changes are made without writing them to non-volatile memory, the module will
revert back to previously saved parameters the next time the module is powered-on.
If the non-volatile user configuration is not correct, WR will re-attempt (up to 3x). If all
three attempts fail, the command will return an ERROR alert.
WS (Sticky Warning
Numbers) Command
command reports warning
numbers of all warnings active
since the last use of the WS or WN command (including any warnings which are
currently active). This command also resets all non-zero warning counts, except
for warnings that are presently active, which are set to 1.
API Operation
By default, ZP9D-115RM-LR Radio Modem acts as a serial line replacement
(Transparent Operation) - all UART data received through the DI pin is queued up for
RF transmission. When the module receives an RF packet, the data is sent out the
DO pin with no additional information.
Inherent to Transparent Operation are the following behaviors:
• If module parameter registers are to be set or queried, a special operation is
required for transitioning the module into Command Mode [refer to p17].
• In point-to-multipoint systems, the application must send extra information so that
the receiving module(s) can distinguish between data coming from different
remotes.
As an alternative to the default Transparent Operation, API (Application Programming
Interface) Operations are available. API operation requires that communication with
the module be done through a structured interface (data is communicated in frames in
a defined order). The API specifies how commands, command responses and module
status messages are sent and received from the module using a UART Data Frame.
API Frame Specifications
Two API modes are supported and both can be enabled using the AP (API Enable)
command. Use the following AP parameter values to configure the module to operate
in a particular mode:
• AP = 0 (default): Transparent Operation (UART Serial line replacement)�
API modes are disabled.
• AP = 1: API Operation
• AP = 2: API Operation (with escaped characters)
Any data received prior to the start delimiter is silently discarded. If the frame is not
received correctly or if the checksum fails, the data is silently discarded.
AT Command: ATWR
Binary Command: 0x08
AT Command: ATWS
Parameter Range (read-only): 1 - 8
Number of bytes returned: 1