WirelessProtocol
WirelessProtocol

Class containing protocol information for a device.

Variables
m_pingBase
std::function<bool(
BaseStation_Impl*
)> m_pingBase

The function pointer for the Ping BaseStation protocol command.

m_readBaseEeprom
std::function<bool(
BaseStation_Impl*, 
uint16, 
uint16&
)> m_readBaseEeprom

The function pointer for the Read BaseStation EEPROM protocol command.

m_writeBaseEeprom
std::function<bool(
BaseStation_Impl*, 
uint16, 
uint16
)> m_writeBaseEeprom

The function pointer for the Write BaseStation EEPROM protocol command.

m_enableBeacon
std::function<Timestamp(
BaseStation_Impl*, 
uint32
)> m_enableBeacon

The function pointer for the Enable Beacon protocol command.

m_beaconStatus
std::function<BeaconStatus(
BaseStation_Impl*
)> m_beaconStatus

The function pointer for the Beacon Status protocol command.

m_startRfSweep
std::function<void(
BaseStation_Impl*, 
uint32, 
uint32, 
uint32, 
uint16
)> m_startRfSweep

The function pointer for the Start RF Sweep Mode protocol command.

m_shortPing
std::function<bool(
BaseStation_Impl*, 
NodeAddress
)> m_shortPing

The function pointer for the Short Ping Node protocol command.

m_readNodeEeprom
std::function<bool(
BaseStation_Impl*, 
NodeAddress, 
uint16, 
uint16&
)> m_readNodeEeprom

The function pointer for the Read Node Eeprom protocol command.

m_writeNodeEeprom
std::function<bool(
BaseStation_Impl*, 
NodeAddress, 
uint16, 
uint16
)> m_writeNodeEeprom

The function pointer for the Write Node Eeprom protocol command.

m_pageDownload
std::function<bool(
BaseStation_Impl*, 
NodeAddress, 
uint16, 
ByteStream&
)> m_pageDownload

The function pointer for the Node Page Download protocol command.

m_autoBalance
std::function<bool(
BaseStation_Impl*, 
NodeAddress, 
uint8, 
float, 
AutoBalanceResult&
)> m_autoBalance

The function pointer for the Node AutoBalance protocol command.

Constants
BASE_STATION_ADDRESS

The address of our generic Base Station.

Functions
chooseBaseStationProtocol
static std::unique_ptr<WirelessProtocol> chooseBaseStationProtocol(
const Version &fwVersion
)

Returns the correct protocol version based on the Base Station's firmware vesrion.

Parameters
fwVersion
const Version&

The firmware version of the Base Station.

chooseBaseStationProtocol

Returns the correct protocol version based on the Wireless Node's firmware vesrion.

Parameters
fwVersion

The firmware version of the Node.

v1_0
static std::unique_ptr<WirelessProtocol> v1_0()

Static function to create a WirelessProtocol with version 1.0.

v1_1
static std::unique_ptr<WirelessProtocol> v1_1()

Static function to create a WirelessProtocol with version 1.1.

v1_2
static std::unique_ptr<WirelessProtocol> v1_2()

Static function to create a WirelessProtocol with version 1.2.

v1_3
static std::unique_ptr<WirelessProtocol> v1_3()

Static function to create a WirelessProtocol with version 1.3.