XBee modules

Dependencies:   DigiLogger

Fork of XBeeLib by Digi International Inc.

Embed: (wiki syntax)

« Back to documentation index

RemoteXBee802 Class Reference

Class for 802.15.4 Remote XBee modules. More...

#include <RemoteXBee.h>

Inherits XBeeLib::RemoteXBee.

Public Member Functions

 RemoteXBee802 ()
 Default Class constructor for a 802.15.4 remote device (connected wirelessly).
 RemoteXBee802 (uint64_t remote64)
 Class constructor for a 802.15.4 remote device (connected wirelessly) using 64bit addressing.
 RemoteXBee802 (uint16_t remote16)
 Class constructor for a 802.15.4 remote device (connected wirelessly) using 16bit addressing.
 ~RemoteXBee802 ()
 Class destructor.
uint64_t get_addr64 () const
 get_addr64 - returns the 64bit address of the remote device
uint16_t get_addr16 () const
 get_addr16 - returns the 16bit address of the remote device
bool operator== (const RemoteXBee &b) const
 operator == overload so the object can be compared to equal
bool operator!= (const RemoteXBee &b) const
 operator != overload so the object can be compared to not equal
bool is_valid_addr16b () const
 is_valid_addr16b - checks if the RemoteXBee object has a valid 16b address
bool is_valid_addr64b () const
 is_valid_addr64b - checks if the RemoteXBee object has a valid 64b address

Protected Member Functions

 RemoteXBee802 (uint64_t remote64, uint16_t remote16)
 Class constructor for a 802.15.4 remote device (connected wirelessly) for which both the 64-bit and 16-bit addresses are known.

Protected Attributes

uint64_t _dev_addr64
 Remote Device 64 bit address.
uint16_t _dev_addr16
 Remote Device 16 bit address.

Detailed Description

Class for 802.15.4 Remote XBee modules.

Definition at line 89 of file RemoteXBee.h.


Constructor & Destructor Documentation

Default Class constructor for a 802.15.4 remote device (connected wirelessly).

No address set.

Definition at line 42 of file RemoteXBee.cpp.

RemoteXBee802 ( uint64_t  remote64 )

Class constructor for a 802.15.4 remote device (connected wirelessly) using 64bit addressing.

Parameters:
remote64the 64-bit address (ATSH and ATSL parameters) of the remote XBee module

Definition at line 46 of file RemoteXBee.cpp.

RemoteXBee802 ( uint16_t  remote16 )

Class constructor for a 802.15.4 remote device (connected wirelessly) using 16bit addressing.

Parameters:
remote16the 16-bit address (ATMY parameter) of the remote XBee module

Definition at line 50 of file RemoteXBee.cpp.

~RemoteXBee802 (  )

Class destructor.

Definition at line 60 of file RemoteXBee.cpp.

RemoteXBee802 ( uint64_t  remote64,
uint16_t  remote16 
) [protected]

Class constructor for a 802.15.4 remote device (connected wirelessly) for which both the 64-bit and 16-bit addresses are known.

This constructor is only used by FH_NodeDiscovery802 class.

Parameters:
remote64the 64-bit address (ATSH and ATSL parameters) of the remote XBee module
remote16the 16-bit address (ATMY parameter) of the remote XBee module

Definition at line 55 of file RemoteXBee.cpp.


Member Function Documentation

uint16_t get_addr16 (  ) const [inherited]

get_addr16 - returns the 16bit address of the remote device

Returns:
the 16bit address of the remote device

Definition at line 37 of file RemoteXBee.cpp.

uint64_t get_addr64 (  ) const [inherited]

get_addr64 - returns the 64bit address of the remote device

Returns:
the 64bit address of the remote device

Definition at line 32 of file RemoteXBee.cpp.

bool is_valid_addr16b (  ) const [inherited]

is_valid_addr16b - checks if the RemoteXBee object has a valid 16b address

Returns:
true if valid, false otherwise

Definition at line 65 of file RemoteXBee.h.

bool is_valid_addr64b (  ) const [inherited]

is_valid_addr64b - checks if the RemoteXBee object has a valid 64b address

Returns:
true if valid, false otherwise

Definition at line 73 of file RemoteXBee.h.

bool operator!= ( const RemoteXBee b ) const [inherited]

operator != overload so the object can be compared to not equal

Definition at line 57 of file RemoteXBee.h.

bool operator== ( const RemoteXBee b ) const [inherited]

operator == overload so the object can be compared to equal

Definition at line 50 of file RemoteXBee.h.


Field Documentation

uint16_t _dev_addr16 [protected, inherited]

Remote Device 16 bit address.

Definition at line 84 of file RemoteXBee.h.

uint64_t _dev_addr64 [protected, inherited]

Remote Device 64 bit address.

Definition at line 81 of file RemoteXBee.h.