Api operation – B&B Electronics Zlinx ZP Series User Manual

Page 64

Advertising
background image

60

Manual Documentation Number: ZP24D-250RM-SR-2508

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

<(Special)> The WR command is
used to write configurable
parameters to the RF module's
nonvolatile memory. Parameter values remain in the module's memory until
overwritten by subsequent use of the WR Command.

If changes are made without writing them to non-volatile memory, the module reverts
back to previously saved parameters the next time the module is powered-on.

NOTE: Once the WR command is sent to the module, no additional characters should
be sent until after the “OK/r” response is received.

API Operation

By default, Zlinx Radio Modems act 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.
• 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

Advertising