Component: Zigbee (EB051, XBEE) (Wireless)
| Author | Matrix Ltd. |
| Version | 1.3 |
| Category | Wireless |
Contents
- 1 Zigbee (EB051, XBEE) component
- 2 Examples
- 3 Downloadable macro reference
- 3.1 NodeConfigureSleep
- 3.2 ReadNameFromBuffer
- 3.3 NodeWake
- 3.4 ReadATResponse
- 3.5 ScanBuffer
- 3.6 SendChar
- 3.7 InitNetwork
- 3.8 ConnectToCoordinator
- 3.9 ConnectToName
- 3.10 StoreParams
- 3.11 EnterCommandMode
- 3.12 RestartNetwork
- 3.13 ConnectToAll
- 3.14 ConnectFromLibrary
- 3.15 ConnectToAddress
- 3.16 GetSignalLevel
- 3.17 ExitCommandMode
- 3.18 ReadAddressFromBuffer
- 3.19 SendATCommand
- 3.20 ScanNetwork
- 3.21 GetATResponse
- 3.22 ReceiveChar
- 4 Simulation macro reference
- 5 Property reference
Zigbee (EB051, XBEE) component
Zigbee component designed to work with the XBEE range of modules from Digi. Provides a very simple interface to allow Zigbee mesh networks and communications. Also available in the form of the EB051 Zigbee E-block.
Examples
No additional examples
Downloadable macro reference
NodeConfigureSleep
Sets the Zigbee device sleep mode (only applicable for end node type devices) 1=Hibernate, 2=Doze, 4=Cyclic Sleep, 5=Cyclic Doze, Timeout in ms
Parameters
- BYTE Mode
- UINT Timeout
Return value
- This call does not return a value
ReadNameFromBuffer
Returns a byte from the 8-Byte name
Parameters
- BYTE Device
- BYTE Idx
Return value
NodeWake
Wakes up the local Zigbee module from sleep mode.
Parameters
- This macro has no parameters
Return value
ReadATResponse
Reads a single byte from the received AT command response.
Parameters
- BYTE idx
Return value
ScanBuffer
Returns a binary list of matched identifier names
Parameters
- STRING Compare_Str
- BYTE Length
Return value
SendChar
No additional information
Parameters
- BYTE Byte
Return value
- This call does not return a value
InitNetwork
Initialises the Zigbee module and attempts to setup or join the network
Parameters
- This macro has no parameters
Return value
- This call does not return a value
ConnectToCoordinator
Attempts to connect the data channel to the network coordinator node.
Parameters
- This macro has no parameters
Return value
ConnectToName
Attempts to connect the data channel to a named device on the network.
Parameters
- STRING Name
Return value
StoreParams
Stores the current register set into the Zigbee module's non volatile memory
Parameters
- This macro has no parameters
Return value
- This call does not return a value
EnterCommandMode
Moves from data mode into command mode by sending the special characters
Parameters
- This macro has no parameters
Return value
- This call does not return a value
RestartNetwork
Attempts to restart the network
Parameters
- This macro has no parameters
Return value
- This call does not return a value
ConnectToAll
Attempts to connect the data channel to all devices on the network.
Parameters
- This macro has no parameters
Return value
ConnectFromLibrary
Attempts to connect the data channel to a known device on the network.
Parameters
- BYTE Mode
- BYTE Device
Return value
ConnectToAddress
Attempts to connect the data channel to a specific device address on the network.
Parameters
- STRING Address
Return value
GetSignalLevel
Returns the signal strength of the last signal received
Parameters
- This macro has no parameters
Return value
ExitCommandMode
Returns from command mode to allow data to be sent and received
Parameters
- This macro has no parameters
Return value
- This call does not return a value
ReadAddressFromBuffer
Reads a byte from a 16-bit Zigbee device address
Parameters
- BYTE Device
- BYTE Idx
Return value
SendATCommand
No additional information
Parameters
- STRING Command
- Transmits a command to the Zigbee module followed by a carriage return
Return value
- This call does not return a value
ScanNetwork
Scans the local network for devices and stores into a local device array. Mode = 0 store device names, mode = 1 store device addresses. Returns the number of devices found.
Parameters
- BYTE Mode
Return value
GetATResponse
Waits for a response from the Zigbee module. If the Logging parameter is set then the response is stored in memory allowing the software to read the reply.
Parameters
- BYTE Logging
Return value
ReceiveChar
No additional information
Parameters
- BYTE nTimeout
Return value
Simulation macro reference
This component does not contain any simulation macros
Property reference
Device Name
This property is of type Line of text and can be referenced with the variable name dev_name.
No additional information
Zigbee Mode
This property is of type Fixed list of ints and can be referenced with the variable name zig_mode.
No additional information
Auto ID
This property is of type True or false and can be referenced with the variable name auto_id.
No additional information
PAN ID
This property is of type Line of text and can be referenced with the variable name pan_id.
No additional information
Node Join Time
This property is of type Fixed list of ints and can be referenced with the variable name join_time.
No additional information
Verbose Mode
This property is of type True or false and can be referenced with the variable name verbose.
No additional information
Max Hops
This property is of type Signed integer and can be referenced with the variable name max_hops.
No additional information
Sleep Buffer Time
This property is of type Fixed list of ints and can be referenced with the variable name sleep_buffer.
No additional information
UART Channel
This property is of type Fixed list of ints and can be referenced with the variable name Channel.
No additional information
RX Pin
This property is of type Single digital pin and can be referenced with the variable name rx_pin.
No additional information
TX Pin
This property is of type Single digital pin and can be referenced with the variable name tx_pin.
No additional information
Sleep Pin
This property is of type Single digital pin and can be referenced with the variable name pin_sleep.
No additional information
Flow Control
This property is of type True or false and can be referenced with the variable name flow_control.
No additional information
RTS Pin
This property is of type Single digital pin and can be referenced with the variable name pin_rts.
No additional information
CTS Pin
This property is of type Single digital pin and can be referenced with the variable name pin_cts.
No additional information
0x0B
This property is of type True or false and can be referenced with the variable name chan_0.
No additional information
0x0C
This property is of type True or false and can be referenced with the variable name chan_1.
No additional information
0x0D
This property is of type True or false and can be referenced with the variable name chan_2.
No additional information
0x0E
This property is of type True or false and can be referenced with the variable name chan_3.
No additional information
0x0F
This property is of type True or false and can be referenced with the variable name chan_4.
No additional information
0x10
This property is of type True or false and can be referenced with the variable name chan_5.
No additional information
0x11
This property is of type True or false and can be referenced with the variable name chan_6.
No additional information
0x12
This property is of type True or false and can be referenced with the variable name chan_7.
No additional information
0x13
This property is of type True or false and can be referenced with the variable name chan_8.
No additional information
0x14
This property is of type True or false and can be referenced with the variable name chan_9.
No additional information
0x15
This property is of type True or false and can be referenced with the variable name chan_10.
No additional information
0x16
This property is of type True or false and can be referenced with the variable name chan_11.
No additional information
0x17
This property is of type True or false and can be referenced with the variable name chan_12.
No additional information
0x18
This property is of type True or false and can be referenced with the variable name chan_13.
No additional information
0x19
This property is of type True or false and can be referenced with the variable name chan_14.
No additional information
0x1A
This property is of type True or false and can be referenced with the variable name chan_15.
No additional information
Scan Duration
This property is of type Signed integer and can be referenced with the variable name scan_duration.
No additional information
Total Scan Time (ms)
This property is of type Signed integer and can be referenced with the variable name scan_total.
No additional information
Label
This property is of type Line of text and can be referenced with the variable name label.
No additional information
