explicit BaseStation_Impl( |
| ) |
Creates a BaseStation_Impl object. Note: This will communicate with the BaseStation to get device information, as well as start the data collection thread.
connection | The Connection object used for communication. |
baseTimeout uint64 | The timeout (in milliseconds) to use for base station commands. |
Error_Connection: Failed to communicate with the BaseStation.
Destroys the BaseStation object
The wireless packet collector used to store wireless data packets
The response collector used to find and store wireless command responses
The wireless parser in charge of parsing all incoming data to this base station
The timeout (in milliseconds) to use for base station commands.
The timeout (in milliseconds) to use for node commands.
The last known radio frequency (WirelessTypes::Frequency) that the BaseStation was known to be on
The BaseStationEeprom that handles reading and writing eeprom values with the BaseStation and eeprom cache.
The BaseStationEepromHelper used for high level eeprom reads and writes on the BaseStation.
The BaseStationFeatures containing the features for this BaseStation.
The WirelessProtocol containing all of the protocol commands and info for this BaseStation.
A Timestamp representing the last time communication was achieved with the BaseStation.
A map of NodeAddress to Timestamp objects, holding the last communication time for nodes with this BaseStation.
Gets the system time in UTC seconds since Unix Epoch as close to 0 milliseconds as possible
The system time in UTC seconds since Unix Epoch to enable the beacon with
void parseData( |
| ) |
Callback function that parses any bytes that are in the read buffer to find packets or command responses
data | The DataBuffer containing all the data to be parsed |
Determines the WirelessProtocol to use based on the BaseStation's firmware version.
A unique_ptr containing the WirelessProtocol to use.
Error_NotSupported: Attempted to read an unsupported option. The device firmware is not compatible with this version of MSCL.
Error_Communication: Failed to communicate with the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
Gets a reference to the BaseStationEepromHelper for this BaseStation.
A reference to the BaseStationEepromHelper.
bool doCommand( |
| ) |
Performs a custom command and waits for the response.
response | A reference to a custom class that was inherited from the ResponsePattern base class. |
cmdBytes const ByteStream& | The ByteStream containing the command bytes to send. |
timeout uint64 | The maximum timeout to use for waiting for the response. |
true if the command was successful (response.success() is true), false otherwise.
Gets a reference to the BaseStationFeatures for this BaseStation.
BaseStationFeatures containing the features for this BaseStation.
Error_NotSupported: The BaseStation model, or firmware version, is not supported by MSCL.
Error_Communication: Failed to communicate with the BaseStation.
Error_Connection: A connection error has occurred with the parent BaseStation.
Gets a reference to the WirelessProtocol for this BaseStation. Note: This requires communicating to the BaseStation if creating the protocol for the first time.
Error_NotSupported: Attempted to read an unsupported option. The device firmware is not compatible with this version of MSCL.
Error_Communication: Failed to communicate with the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
Gets the Timestamp for the last time we communicated with the BaseStation.
bool read( |
| ) |
Reads the value from the BaseStation for a specified eeprom location.
eepromAddress uint16 | The Eeprom address to get the value for. |
result uint16& | The value that was read from Eeprom if successful. |
true if the read was successful, false otherwise.
Error_NotSupported: Unsupported eeprom location.
Error_Connection: A connection error has occurred with the BaseStation.
bool write( |
| ) |
Writes a value to the BaseStation at a specified eeprom location.
eepromAddress uint16 | The Eeprom address to set the value for. |
value uint16 | The value to write to the Eeprom. |
true if the write was successful, false otherwise.
Error_NotSupported: Unsupported eeprom location or value.
Error_Connection: A connection error has occurred with the BaseStation.
void readWriteRetries( |
| ) |
Sets the number of retry attempts for reading and writing with the BaseStation.
numRetries uint8 | The number of retries to set for all reading and writing with the BaseStation. |
void useEepromCache( |
| ) |
Sets whether or not to utilize the eeprom cache when configuring this BaseStation (default of enabled). This can be enabled/disabled at any time. Note: The eeprom cache stores the last known value that was written to / read from the BaseStation for each eeprom location. If this is enabled, any reads will get the last known value from the cache if it exists, and any writes will not write to the BaseStation if the value attempting to be written is the same as that stored in the cache. Caching of these values will still be performed if this is disabled, however, read and write operations will then always reach out to the actual device.
useCache bool | whether the eeprom cache should be used (true) or not (false). |
Clears the eeprom cache for this BaseStation.
Gets the WirelessTypes::Frequency representing the radio frequency of this BaseStation. If the frequency is unknown, it will be read from the BaseStation.
The WirelessTypes::Frequency that this BaseStation is on.
Error_NotSupported: Attempted to read an unsupported option. The device firmware is not compatible with this version of MSCL.
Error_Communication: Failed to read the value from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
Gets the WirelessTypes::RegionCode representing the region of this BaseStation.
The WirelessTypes::RegionCode of this BaseStation.
Error_NotSupported: Attempted to read an unsupported option. The device firmware is not compatible with this version of MSCL.
Error_Communication: Failed to read the value from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
Gets the firmware version of the BaseStation.
A Version representing the firmware version of the BaseStation.
Error_NotSupported: Attempted to read an unsupported option. The device firmware is not compatible with this version of MSCL.
Error_Communication: Failed to read the value from the BaseStation.
Error_Connection: A connection error has occurred with the parent BaseStation.
Gets the model of the BaseStation.
A WirelessModels::BaseModel representing the model of the BaseStation.
Error_NotSupported: Attempted to read an unsupported option. The device firmware is not compatible with this version of MSCL.
Error_Communication: Failed to read the value from the BaseStation.
Error_Connection: A connection error has occurred with the parent BaseStation.
Gets the serial number of the BaseStation.
A string representing the serial number of the BaseStation.
Error_NotSupported: Attempted to read an unsupported option. The device firmware is not compatible with this version of MSCL.
Error_Communication: Failed to read the value from the BaseStation.
Error_Connection: A connection error has occurred with the parent BaseStation.
Gets the microcontroller of the BaseStation.
A WirelessTypes::MicroControllerType representing the microcontroller of the BaseStation.
Error_NotSupported: Attempted to read an unsupported option. The device firmware is not compatible with this version of MSCL.
Error_Communication: Failed to read the value from the BaseStation.
Error_Connection: A connection error has occurred with the parent BaseStation.
void getData( |
| ) |
Gets up to the requested amount of DataSweeps of sampled data that was collected by this BaseStation.
sweeps std::vector<DataSweep>& | The vector of DataSweep to hold the result. |
timeout uint32 | The timeout, in milliseconds, to wait for data if necessary (default of 0). |
maxSweeps uint32 | The maximum number of sweeps to return. If this is 0 (default), all sweeps will be returned. |
Error_Connection: A connection error has occurred with the BaseStation
Gets the group of Node Discoveries that were collected by this base station. Calling this function clears out the Node Discovery buffer, so repeatedly calling this will give you any new Node Discoveries.
A NodeDiscoveries container, holding all the Node Discoveries that were collected by this base station.
Error_Connection: A connection error has occurred with the BaseStation
void timeout( |
| ) |
Sets the timeout to use when waiting for responses from commands.
timeout uint64 | The timeout (in milliseconds) to set. |
Gets the current timeout to use when waiting for responses from commands.
The timeout (in milliseconds) set.
Gets the current timeout to use when waiting for responses from node commands
A TimeSpan representing the timeout set for node commands
Pings the base station
true if successfully pinged the base station, false otherwise
Error_Connection: A connection error has occurred with the BaseStation
virtual uint16 readEeprom( |
| ) const |
Reads a specific EEPROM address on the BaseStation. If the value stored in the eeprom cache is still valid, this will be returned instead.
eepromAddress uint16 | The EEPROM address to be read. |
The uint16 value read from the specified EEPROM location.
Error_NotSupported: Attempted to read an unsupported eeprom location.
Error_Communication: Failed to read the value from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
virtual Value readEeprom( |
| ) const |
Reads a value from the given EepromLocation of the BaseStation. If the value stored in the eeprom cache is still valid, this will be returned instead.
location const EepromLocation& | The EepromLocation to read from. |
The value read from the specified EEPROM location as a Value object.
Error_NotSupported: Attempted to read an unsupported eeprom location.
Error_Communication: Failed to read the value from the BaseStation.
Error_Connection: A connection error has occurred with BaseStation.
virtual void writeEeprom( |
| ) |
Writes the specified uint16 value to a specific EEPROM address on the BaseStation. If successful, the cache will be updated with the changed value as well.
eepromAddress uint16 | The EEPROM address to write to. |
value uint16 | The value to write to the EEPROM address. |
Error_NotSupported: Unsupported eeprom location or value.
Error_Communication: Failed to write the value to the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
virtual void writeEeprom( |
| ) |
Writes a value to the given EepromLocation of the BaseStation. If successful, the cache will be updated with the changed value as well.
location const EepromLocation& | The specific EepromLocation to write to. |
value | The value to write to the eeprom location, as a Value. |
Error_NotSupported: Unsupported eeprom location or value.
Error_Communication: Failed to write the value to the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
Enables the beacon on the base station using the system time (UTC) as its starting timestamp.
A Timestamp representing the initial time that was sent to start the beacon
Error_Connection: A connection error has occurred with the BaseStation
Error_Communication: The enable beacon command has failed.
virtual Timestamp enableBeacon( |
| ) |
Enables the beacon on the base station using the given UTC timestamp.
utcTime uint32 | The start time for the beacon in UTC seconds from the Unix Epoch (01/01/1970) |
A Timestamp representing the initial time that was sent to start the beacon
Error_Connection: A connection error has occurred with the BaseStation
Error_Communication: The enable beacon command has failed.
Disables the beacon on the base station.
Error_Connection: A connection error has occurred with the BaseStation
Error_Communication: The disable beacon command has failed.
Gets the BeaconStatus of the beacon on the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
Error_Communication: The beacon status command has failed.
virtual void startRfSweepMode( |
| ) |
Starts the BaseStation in RF Sweep Mode.
Error_NotSupported: RF Sweep Mode is not supported by this BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
Error_Communication: The beacon status command has failed.
Cycles the power on the base station.
Error_NotSupported: Attempted to write an unsupported option. The device firmware is not compatible with this version of MSCL.
Error_Connection: A connection error has occurred with the BaseStation.
Error_Communication: Failed to cycle the power on the BaseStation.
Resets the radio on the base station.
Error_NotSupported: Attempted to write an unsupported option. The device firmware is not compatible with this version of MSCL.
Error_Connection: A connection error has occurred with the BaseStation.
Error_Communication: Failed to cycle the power on the BaseStation.
void changeFrequency( |
| ) |
Changes the radio frequency of the base station.
frequency | The WirelessTypes::Frequency to change the base station to. |
Error_NotSupported: Attempted to write an unsupported option. The device firmware is not compatible with this version of MSCL.
Error_Connection: A connection error has occurred with the BaseStation
Error_Communication: Failed to change the frequency.
bool verifyConfig( |
| ) const |
Checks whether the settings in the given BaseStationConfig are ok to be written to the BaseStation. Options that are set will also be validated against each other. If an option that needs to be validated isn't currently set, it will be read from the BaseStation.
config const BaseStationConfig& | The BaseStationConfig to verify. |
outIssues ConfigIssues& | The ConfigIssues that will hold any resulting issues that are found with the configuration. |
true if the configuration is valid. false if the configuration is invalid and outIssues should be checked for more information.
Error_NotSupported: Attempted to read an unsupported option. The device firmware is not compatible with this version of MSCL.
Error_Communication: Failed to communicate with the BaseStation.
Error_Connection: A connection error has occurred.
void applyConfig( |
| ) |
Applies a BaseStationConfig to the Node.
config const BaseStationConfig& | The BaseStationConfig to apply to the Node. |
Error_InvalidConfig: Invalid Configuration. Check the exception for specific details.
Error_Communication: Failed to write to the BaseStation.
Error_Connection: A connection error has occurred with the parent BaseStation.
Reads the WirelessTypes::TransmitPower that is currently set on the BaseStation.
Error_NotSupported: Attempted to read an unsupported option. The device firmware is not compatible with this version of MSCL.
Error_Communication: Failed to read from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
BaseStationButton getButtonLongPress( |
| ) const |
Gets the current button settings for a long press action, as a BaseStationButton.
buttonNumber uint8 | The button number (1 = button 1) to get the value for. |
- Error_NotSupported | The BaseStation does not support the requested button. - Error_Communication: Failed to read from the BaseStation. - Error_Connection: A connection error has occurred with the BaseStation. |
BaseStationButton getButtonShortPress( |
| ) const |
Gets the current button settings for a short press action, as a BaseStationButton.
buttonNumber uint8 | The button number (1 = button 1) to get the value for. |
- Error_NotSupported | The BaseStation does not support the requested button. - Error_Communication: Failed to read from the BaseStation. - Error_Connection: A connection error has occurred with the BaseStation. |
Gets the current setting for if Analog Pairing is enabled or not.
Error_NotSupported: The BaseStation does not support Analog Pairing.
Error_Communication: Failed to read from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
Reads the Analog Timeout Time in seconds that is currently set on the BaseStation.
Error_NotSupported: The BaseStation does not support Analog Pairing.
Error_Communication: Failed to read from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
Reads the Analog Timeout Voltage that is currently set on the BaseStation.
Error_NotSupported: The BaseStation does not support Analog Pairing.
Error_Communication: Failed to read from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
Reads the Analog Exceedance enabled/disabled setting that is currently set on the BaseStation.
Error_NotSupported: The BaseStation does not support Analog Pairing.
Error_Communication: Failed to read from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
BaseStationAnalogPair getAnalogPair( |
| ) const |
Reads the BaseStationAnalogPair for the specified port number that is currently set on the BaseStation.
portNumber uint8 | The port number (1 = port 1) to get the value for. |
Error_NotSupported: The BaseStation does not support Analog Pairing.
Error_Communication: Failed to read from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
Performs version 1 of the Ping BaseStation command.
true if successfully pinged the base station, false otherwise.
Error_Connection: A connection error has occurred with the BaseStation.
Performs version 2 of the Ping BaseStation command.
true if successfully pinged the base station, false otherwise.
Error_Connection: A connection error has occurred with the BaseStation.
bool read_v1( |
| ) |
Performs version 1 of the Read BaseStation EEPROM command.
eepromAddress uint16 | The Eeprom address to get the value for. |
result uint16& | The value that was read from Eeprom if successful. |
true if the read was successful, false otherwise.
Error_Connection: A connection error has occurred with the BaseStation.
bool read_v2( |
| ) |
Performs version 2 of the Read BaseStation EEPROM command.
eepromAddress uint16 | The Eeprom address to get the value for. |
result uint16& | The value that was read from Eeprom if successful. |
true if the read was successful, false otherwise.
Error_NotSupported: Unsupported eeprom location.
Error_Connection: A connection error has occurred with the BaseStation.
bool write_v1( |
| ) |
Performs version 1 of the Write BaseStation EEPROM command.
eepromAddress uint16 | The Eeprom address to set the value for. |
value uint16 | The value to write to the Eeprom. |
true if the write was successful, false otherwise.
Error_Connection: A connection error has occurred with the BaseStation.
bool write_v2( |
| ) |
Performs version 2 of the Write BaseStation EEPROM command.
eepromAddress uint16 | The Eeprom address to set the value for. |
value uint16 | The value to write to the Eeprom. |
true if the write was successful, false otherwise.
Error_NotSupported: Unsupported eeprom location or value.
Error_Connection: A connection error has occurred with the BaseStation.
Timestamp enableBeacon_v1( |
| ) |
Performs version 1 of the Enable Beacon command.
utcTime uint32 | The start time for the beacon in UTC seconds from the Unix Epoch (01/01/1970). |
A Timestamp representing the initial time that was sent to start the beacon.
Error_Connection: A connection error has occurred with the BaseStation
Error_Communication: The enable beacon command has failed.
Timestamp enableBeacon_v2( |
| ) |
Performs version 2 of the Enable Beacon command.
utcTime uint32 | The start time for the beacon in UTC seconds from the Unix Epoch (01/01/1970). |
A Timestamp representing the initial time that was sent to start the beacon.
Error_Connection: A connection error has occurred with the BaseStation
Error_Communication: The enable beacon command has failed.
Performs version 1 of the Beacon Status command.
A BeaconStatus object containing status information of the beacon.
Error_Connection: A connection error has occurred with the BaseStation
Error_Communication: The beacon status command has failed.
bool node_pageDownload_v1( |
| ) |
Performs Version 1 of the Node Page Download command.
nodeAddress | The node address of the Node to download data from |
pageIndex uint16 | The page index to download from the Node |
data | Output parameter that contains the resulting data downloaded from the Node, if any |
true if the page download command succeeded, false otherwise
Error_Connection: A connection error has occurred with the BaseStation
bool node_shortPing_v1( |
| ) |
Performs Version 1 of the Node Short Ping command.
nodeAddress | The node address of the Node to short ping. |
true if the short ping command succeeded, false otherwise.
Error_Connection: A connection error has occurred with the BaseStation.
bool node_shortPing_v2( |
| ) |
Performs Version 2 of the Node Short Ping command.
nodeAddress | The node address of the Node to short ping. |
true if the short ping command succeeded, false otherwise.
Error_Connection: A connection error has occurred with the BaseStation.
bool node_readEeprom_v1( |
| ) |
Performs Version 1 of the Node Read Eeprom command.
nodeAddress | the node address of the node to read from. |
eepromAddress uint16 | the EEPROM address to read the value from. |
eepromValue uint16& | holds the result value read from EEPROM if successful. |
true if the command was successful, false otherwise.
Error_Connection: A connection error has occurred with the BaseStation
bool node_readEeprom_v2( |
| ) |
Performs Version 2 of the Node Read Eeprom command.
nodeAddress | the node address of the node to read from. |
eepromAddress uint16 | the EEPROM address to read the value from. |
eepromValue uint16& | holds the result value read from EEPROM if successful. |
true if the command was successful, false otherwise.
Error_NotSupported: Unsupported eeprom location.
Error_Connection: A connection error has occurred with the BaseStation
bool node_writeEeprom_v1( |
| ) |
Performs Version 1 of the Node Write Eeprom command.
nodeAddress | the node address of the node to write to. |
eepromAddress uint16 | the EEPROM address to write the value to. |
value uint16 | the value to write to EEPROM. |
true if the write eeprom command succeeded, false otherwise.
Error_Connection: A connection error has occurred with the BaseStation
bool node_writeEeprom_v2( |
| ) |
Performs Version 2 of the Node Write Eeprom command.
nodeAddress | the node address of the node to write to. |
eepromAddress uint16 | the EEPROM address to write the value to. |
value uint16 | the value to write to EEPROM. |
true if the write eeprom command succeeded, false otherwise.
Error_NotSupported: Unsupported eeprom location or value.
Error_Connection: A connection error has occurred with the BaseStation
bool node_autoBalance_v1( |
| ) |
Performs Version 1 of the Node AutoBalance command.
nodeAddress | The node address of the Node to send the command to. |
channelNumber uint8 | The channel number (ch1 = 1, ch8 = 8) to balance. |
targetPercent float | The target percentage (0 - 100) to balance to. |
result | The AutoBalanceResult of the command (empty in the case of v1). |
true if the command succeeded, false if it failed.
Error_Connection: A connection error has occurred with the BaseStation.
bool node_autoBalance_v2( |
| ) |
Performs Version 2 of the Node AutoBalance command.
nodeAddress | The node address of the Node to send the command to. |
channelNumber uint8 | The channel number (ch1 = 1, ch8 = 8) to balance. |
targetPercent float | The target percentage (0 - 100) to balance to. |
result | The AutoBalanceResult of the command. |
true if the command succeeded, false if it failed.
Error_Connection: A connection error has occurred with the BaseStation.
const Timestamp& node_lastCommunicationTime( |
| ) |
Gets the Timestamp for the last time MSCL communicated with the given node address.
nodeAddress | The node address of the Node to check for. |
virtual PingResponse node_ping( |
| ) |
Pings the specified Node.
nodeAddress | the node address of the Node to ping. |
A PingResponse object that can be queried to get details of the ping command's response.
Error_Connection: A connection error has occurred with the BaseStation.
virtual bool node_sleep( |
| ) |
Puts the Node into a low power, sleep mode. This command attempts to ping the node before sending the sleep command, to verify communication.
nodeAddress | The node adderss of the Node to put to sleep. |
true if the sleep command was successful, false otherwise.
Error_Connection: A connection error has occurred with the BaseStation.
virtual SetToIdleStatus node_setToIdle( |
| ) |
Attempts to set the node to idle so that it can be communicated with.
nodeAddress | the node address of the node to ping. |
base const BaseStation& | A reference to the BaseStation that will be used for setting the node to idle. |
A SetToIdleStatus object that can be queried to get the status of the Set to Idle operation.
Error_Connection: A connection error has occurred with the BaseStation.
bool node_shortPing( |
| ) |
Pings a specific node.
nodeAddress | the node address of the node to ping. |
true if successfully pinged the node, false otherwise
Error_Connection: A connection error has occurred with the BaseStation.
virtual bool node_readEeprom( |
| ) |
Reads a value from EEPROM on the specified Node.
nodeProtocol const WirelessProtocol& | the WirelessProtocol for the Node. |
nodeAddress | the node address of the Node to read from. |
eepromAddress uint16 | the EEPROM address to read the value from. |
eepromValue uint16& | holds the result value read from EEPROM if successful. |
true if the command was successful, false otherwise.
Error_NotSupported: Unsupported eeprom location.
Error_Connection: A connection error has occurred with the BaseStation
virtual bool node_writeEeprom( |
| ) |
Writes a value to EEPROM on the specified Node.
nodeProtocol const WirelessProtocol& | the WirelessProtocol for the Node. |
nodeAddress | the node address of the node to write to. |
eepromAddress uint16 | the EEPROM address to write the value to. |
value uint16 | the value to write to EEPROM. |
true if the write eeprom command succeeded, false otherwise.
Error_NotSupported: Unsupported eeprom location or value.
Error_Connection: A connection error has occurred with the BaseStation
virtual bool node_pageDownload( |
| ) |
Download a page of logged data from the Node
nodeProtocol const WirelessProtocol& | The WirelessProtocol for the Node. |
nodeAddress | The node address of the Node to download data from |
pageIndex uint16 | The page index to download from the Node |
data | Output parameter that contains the resulting data downloaded from the Node, if any |
true if the page download command succeeded, false otherwise
Error_Connection: A connection error has occurred with the BaseStation
virtual bool node_startSyncSampling( |
| ) |
Sends the Start Synchronized Sampling command to a Node.
nodeAddress | The node address of the Node to send the command to. |
true if the Start Sync Sampling command succeeded, false otherwise.
Error_Connection: A connection error has occurred with the BaseStation.
Sends the Start Non-Synchronized Sampling command to a Node.
nodeAddress | The node address of the Node to send the command to. |
Error_Connection: A connection error has occurred with the BaseStation.
virtual bool node_armForDatalogging( |
| ) |
Sends the Arm For Datalogging command to a Node.
nodeAddress | The node address of the Node to send the command to. |
message const std::string& | A message, up to 50 characters, to send with the arm command. This message can be downloaded with the data. Will be trimmed to 50 chars if longer. |
true if the Arm For Datalogging command succeeded, false otherwise.
Error_Connection: A connection error has occurred with the BaseStation.
virtual void node_triggerArmedDatalogging( |
| ) |
Sends the Trigger Armed Datalogging command to a Node.
nodeAddress | The node address of the Node to send the command to. |
Error_Connection: A connection error has occurred with the BaseStation.
virtual bool node_erase( |
| ) |
Sends the Erase command to a Node.
nodeAddress | The node address of the Node to send the command to. |
Error_Connection: A connection error has occurred with the BaseStation.
virtual bool node_autoBalance( |
| ) |
Sends the AutoBalance command to a Node.
nodeProtocol const WirelessProtocol& | The WirelessProtocol for the Node. |
nodeAddress | The node address of the Node to send the command to. |
channelNumber uint8 | The channel number (ch1 = 1, ch8 = 8) to balance. |
targetPercent float | The target percentage (0 - 100) to balance to. |
result | The AutoBalanceResult of the command. |
true if the command succeeded, false if it failed.
Error_Connection: A connection error has occurred with the BaseStation.
bool node_autocal( |
| ) |
Performs automatic calibration for a Wireless Node.
nodeAddress | The node address of the Node to send the command to. |
model | The WirelessModels::NodeModel of the Node. |
fwVersion const Version& | The firmware Version of the Node. |
result | The AutoCalResult reference to hold the result. |
true if the AutoCal command was successful, false otherwise.
Error_Connection: A connection error has occurred with the BaseStation.
bool node_readSingleSensor( |
| ) |
Reads the bits value for a single channel on a Wireless Node.
nodeAddress | The node address of the Node to send the command to. |
channelNumber uint8 | The channel number (ch1 = 1, ch8 = 8) to read. |
result uint16& | Holds the bits value result from the channel on the Node. |
true if the Read Single Sensor command was successful, false otherwise.
Error_Connection: A connection error has occurred with the BaseStation.