Library to easily communicate with XBee modules.

Dependencies:   DigiLogger

Dependents:   WaterLogger XbeeGateway XBee_Cooker ProjetReceiver ... more

Embed: (wiki syntax)

« Back to documentation index

RemoteXBee Class Reference

RemoteXBee Class Reference

Class for Remote XBee modules. More...

#include <RemoteXBee.h>

Inherited by RemoteXBee802, RemoteXBeeDM, and RemoteXBeeZB.

Public Member Functions

 RemoteXBee ()
 Default Class constructor for a remote device (connected wirelessly).
 RemoteXBee (uint64_t remote64)
 Class constructor for a remote device (connected wirelessly) using 64bit addressing.
 ~RemoteXBee ()
 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 Attributes

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

Detailed Description

Class for Remote XBee modules.

Not to be used directly.

Definition at line 21 of file RemoteXBee.h.


Constructor & Destructor Documentation

RemoteXBee (  )

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

No address set.

Definition at line 17 of file RemoteXBee.cpp.

RemoteXBee ( uint64_t  remote64 )

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

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

Definition at line 23 of file RemoteXBee.cpp.

~RemoteXBee (  )

Class destructor.

Definition at line 28 of file RemoteXBee.cpp.


Member Function Documentation

uint16_t get_addr16 (  ) const

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

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

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

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

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

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]

Remote Device 16 bit address.

Definition at line 84 of file RemoteXBee.h.

uint64_t _dev_addr64 [protected]

Remote Device 64 bit address.

Definition at line 81 of file RemoteXBee.h.