UPM

The UPM API is a high level sensor library for IoT devices using MRAA. See examples here. Back to index page.
SparkFun sensor images provided under CC BY-NC-SA-3.0.

XBee Class

Module: xbee

This is a generic UART driver for use with Digi XBee modules. It was tested with the XBee S1 802.15.4 module and the XBee S6B WiFi module.
It provides basic UART support for sending and receiving data to and from the device. It is controlled by an AT or API command set.
It is connected at 9600 baud by default.
These devices are typically configured using Digi's X-CTU windows software, however it is possible of course to configure them manually using AT commands. See the examples.
xbee.jpg

Methods

XBee

(
  • uart
)
Number

XBee object constructor

Parameters:

  • uart Number

    Default UART to use (0 or 1). Default is 0.

Returns:

Number:

dataAvailable

(
  • millis
)
Boolean

Checks to see if there is data available for reading

Parameters:

  • millis Number

    Number of milliseconds to wait; 0 means no waiting

Returns:

Boolean:

true if there is data available for reading

readData

(
  • buffer
  • len
)
Number

Reads any available data into a user-supplied buffer. Note: the call blocks until data is available for reading. Use dataAvailable() to determine whether there is data available beforehand, to avoid blocking.

Parameters:

  • buffer String

    Buffer to hold the data read

  • len Number

    Length of the buffer

Returns:

Number:

Number of bytes read

readDataStr

(
  • len
)
String

Reads any available data and returns it in a std::string. Note: the call blocks until data is available for reading. Use dataAvailable() to determine whether there is data available beforehand, to avoid blocking.

Parameters:

  • len Number

    Maximum length of the data to be returned

Returns:

String:

string containing the data read

writeData

(
  • buffer
  • len
)
Number

Writes the data in the buffer to the device. If you are writing an AT command, be sure to terminate it with a carriage return ()

Parameters:

  • buffer String

    Buffer to hold the data to write

  • len Number

    Length of the buffer

Returns:

Number:

Number of bytes written

writeDataStr

(
  • data
)
Number

Writes the std:string data to the device. If you are writing an AT command, be sure to terminate it with a carriage return ()

Parameters:

  • data String

    Buffer to write to the device

Returns:

Number:

Number of bytes written

setBaudRate

(
  • baud
)
Mraa::Result

Sets the baud rate for the device. The default is 9600.

Parameters:

  • baud Number

    Desired baud rate

Returns:

Mraa::Result:

true if successful

commandMode

(
  • cmdChars
  • guardTimeMS
)
Boolean

Attempts to enter AT Command Mode. When Idle, data sent to the device (assuming it is not in API mode) is silently transmitted to the configured destination. Running this command attempts to place the device into command mode, allowing you to send AT commands. Note, after a configurable period of inactivity, the device will exit command mode automatically (default 10 seconds).
Both the cmdChars (+++) and the Guard Time can be configured on the device to different values using AT configuration commands.

Parameters:

  • cmdChars String

    The command mode characters, default "+++"

  • guardTimeMS Number

    The number of milliseconds to wait before and after sending the command characters. Default is 1000 (1 second).

Returns:

Boolean:

true if successful (received an "OK"), false otherwise

stringCR2LF

(
  • str
)
String

This is a convenience method that converts each CR () in a string to a LF (
) and returns it. This is useful for outputting the response to an AT command for instance, which is typically CR terminated.

Parameters:

  • str String

    The string to convert

Returns:

String:

The converted string