BayEOS-PHP
 All Data Structures Namespaces Files Functions Variables Pages
Public Member Functions
XBeeFrame Class Reference
Inheritance diagram for XBeeFrame:
_XBeeFrameBase

Public Member Functions

 XBeeFrame ()
 
 remoteAtCommand ($address16, $cmd, $val, $address64= '0000000000000000', $options= '02')
 
 localAtCommand ($cmd, $val= '')
 
 queuedAtCommand ()
 
 txCommand ()
 
 txExplicityCommand ()
 
- Public Member Functions inherited from _XBeeFrameBase
 setFrame ($frame)
 
 getFrame ()
 
 setFrameId ($frameId)
 
 getFrameId ()
 
 setApiId ($apiId)
 
 getApiId ()
 
 setCmdData ($cmdData)
 
 getCmdData ()
 
 setStartByte ($startByte)
 
 getStartByte ()
 
 setAddress16 ($address16)
 
 getAddress16 ()
 
 setAddress64 ($address64)
 
 getAddress64 ()
 
 setOptions ($options)
 
 getOptions ()
 
 setCmd ($cmd)
 
 getCmd ()
 
 setValue ($val)
 
 getValue ()
 

Additional Inherited Members

- Data Fields inherited from _XBeeFrameBase
const DEFAULT_START_BYTE = 0x7e
 
const DEFAULT_FRAME_ID = 0x01
 
const REMOTE_API_ID = 0x17
 
const LOCAL_API_ID = 0x08
 
const QUEUED_API_ID = 0x09
 
const TX_API_ID = 0x10
 
const TX_EXPLICIT_API_ID = 0x11
 
 $frameId
 
 $apiId
 
 $cmdData
 
 $startByte
 
 $address16
 
 $address64
 
 $options
 
 $cmd
 
 $val
 
- Protected Member Functions inherited from _XBeeFrameBase
 _XBeeFrameBase ()
 
 _assembleFrame ()
 
 _calcChecksum ($data)
 
 _getFramelength ($data)
 
 _hexstr ($hex)
 
 _strhex ($str)
 
 _packBytes ($data)
 
 _unpackBytes ($data)
 
- Protected Attributes inherited from _XBeeFrameBase
 $frame
 

Detailed Description

Definition at line 310 of file XBeeFrame.php.

Member Function Documentation

localAtCommand (   $cmd,
  $val = '' 
)

Represesnts a local AT Command according to XBee API. Takes command and value, value defaults to nothing

Parameters
String | String$cmd,$val
Returns
void

Definition at line 350 of file XBeeFrame.php.

queuedAtCommand ( )

Not Implemented, do not use

Definition at line 365 of file XBeeFrame.php.

remoteAtCommand (   $address16,
  $cmd,
  $val,
  $address64 = '0000000000000000',
  $options = '02' 
)

Represesnts a remote AT Command according to XBee API. 64 bit address defaults to eight 00 bytes and $options defaults to 02 immediate Assembles frame for sending.

Parameters
$address16,$cmd,$val,$address64,$options
Returns
void

Definition at line 323 of file XBeeFrame.php.

txCommand ( )

Not Implemented, do not use

Definition at line 373 of file XBeeFrame.php.

txExplicityCommand ( )

Not Implemented, do not use

Definition at line 381 of file XBeeFrame.php.

XBeeFrame ( )

Definition at line 311 of file XBeeFrame.php.


The documentation for this class was generated from the following file: