BayEOS-PHP
 All Data Structures Namespaces Files Functions Variables Pages
Public Member Functions | Data Fields | Protected Attributes
XBeeResponse Class Reference
Inheritance diagram for XBeeResponse:
_XBeeFrameBase

Public Member Functions

 XBeeResponse ($response)
 
 getSignalStrength ()
 
 getNodeId ()
 
 getStatus ()
 
 isOk ()
 
 getCmd ()
 
- 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 ()
 

Data Fields

const REMOTE_RESPONSE_ID = '97'
 
const LOCAL_RESPONSE_ID = '88'
 
 RX16 = '81'
 
 $address64
 
 $status
 
 $cmd
 
 $nodeId
 
 $signalStrength
 
- 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 Attributes

 $address16
 
 $status_bytes = array()
 
- Protected Attributes inherited from _XBeeFrameBase
 $frame
 

Additional Inherited Members

- Protected Member Functions inherited from _XBeeFrameBase
 _XBeeFrameBase ()
 
 _assembleFrame ()
 
 _calcChecksum ($data)
 
 _getFramelength ($data)
 
 _hexstr ($hex)
 
 _strhex ($str)
 
 _packBytes ($data)
 
 _unpackBytes ($data)
 

Detailed Description

Definition at line 393 of file XBeeFrame.php.

Member Function Documentation

getCmd ( )

Returns command.

Returns
String $cmd

Definition at line 620 of file XBeeFrame.php.

getNodeId ( )

Gets Node ID aka NI

Returns
String $nodeId

Definition at line 555 of file XBeeFrame.php.

getSignalStrength ( )

Gets signal strength in dB

Returns
String $signalStrength

Definition at line 537 of file XBeeFrame.php.

getStatus ( )

Returns status. If you want boolean use isOk

00 = OK 01 = Error 02 = Invalid Command 03 = Invalid Parameter 04 = No Response

Returns
int $status

Definition at line 588 of file XBeeFrame.php.

isOk ( )

Checks if this resonse was positive

Returns
boolean

Definition at line 597 of file XBeeFrame.php.

XBeeResponse (   $response)

Constructor. Sets up an XBeeResponse

Parameters
String$responseA single frame of response from an XBee

Definition at line 403 of file XBeeFrame.php.

Field Documentation

$address16
protected

Definition at line 395 of file XBeeFrame.php.

$address64

Definition at line 395 of file XBeeFrame.php.

$cmd

Definition at line 395 of file XBeeFrame.php.

$nodeId

Definition at line 395 of file XBeeFrame.php.

$signalStrength

Definition at line 395 of file XBeeFrame.php.

$status

Definition at line 395 of file XBeeFrame.php.

$status_bytes = array()
protected

Definition at line 396 of file XBeeFrame.php.

const LOCAL_RESPONSE_ID = '88'

Definition at line 394 of file XBeeFrame.php.

const REMOTE_RESPONSE_ID = '97'

Definition at line 394 of file XBeeFrame.php.

RX16 = '81'

Definition at line 394 of file XBeeFrame.php.


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