A helper class for reading and writing to a Wireless Node's Eeprom. This class provides eeprom specific parsing so that high-level objects can be converted to their low-level eeprom value equivelent and vice-versa.
NodeEepromHelper( |
| ) |
Creates a NodeEepromHelper object with a WirelessNode_Impl.
node | The WirelessNode_Impl that will be read from and written to. |
Value read( |
| ) const |
Reads an EepromLocation from the Node and returns a Value with the result.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write( |
| ) |
Writes a Value to a given EepromLocation on the Node.
Error_NotSupported: Unsupported eeprom location, or value.
Error_NodeCommunication: Failed to write the value to the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Gets the node address for this Node.
The node address of the Node.
Resets the radio/power on the Node to apply eeprom changes that have been made.
Reads the frequency from the Node.
Returns The WirelessTypes::Frequency of the Node.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Reads the region code from the Node.
The WirelessTypes::RegionCode set on the Node.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Gets the firmware version of the Node.
A Version representing the firmware version of the Node.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Gets the model of the Node.
A WirelessModels::NodeModel representing the model of the Node.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Gets the serial number of the Node.
A string representing the serial number of the Node.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Gets the microcontroller of the Node.
A WirelessTypes::MicroControllerType representing the microcontroller of the Node.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Gets the RadioFeatures of the Node.
The RadioFeatures of the Node.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Gets the total number of bytes available for data storage on the Node. This is an overall count and does not take into account data that is already stored on the Node.
The total number of bytes available for data storage on the Node.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Reads the specific filter 1 eeprom location. Note: this should be used by the SyncSamplingNetwork only, as it bypasses the ChannelMask logic.
Reads the specific filter 2 eeprom location. Note: this should be used by the SyncSamplingNetwork only, as it bypasses the ChannelMask logic.
void write_channelMask( |
| ) |
Writes the channel mask to the Node, representing which channels are active or not.
channels const ChannelMask& | The ChannelMask representing which channels are active and which are not. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to write the value to the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Reads the current channel mask from the Node, representing which channels are active or not.
A ChannelMask object representing which channels are active or not.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_numSweeps( |
| ) |
Writes the number of sweeps which affects the duration of sampling. In the case of Burst sampling, this is the number of sweeps per burst This function assumes the number of sweeps has already been normalized (multiple of 100 and within min/max).
sweeps uint32 | The number of sweeps to write to the Node. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to write the value to the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Reads the current number of sweeps which affects the duration of sampling.
The number of sweeps currently set on the Node.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_unlimitedDuration( |
| ) |
Writes the unlimited duration flag. This is a different eeprom location depending on the sampling mode.
unlimitedDuration bool | Whether unlimited duration should be enabled (true) or disabled (false). |
samplingMode | The WirelessTypes::SamplingMode to set unlimited duration for. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to write the value to the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
bool read_unlimitedDuration( |
| ) const |
Reads the current unlimited duration flag set on the Node. This is a different eeprom location depending on the sampling mode.
samplingMode | The WirelessTypes::SamplingMode to get the unlimited duration flag for. |
true if the Node is set to unlimited duration, false otherwise
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_sampleRate( |
| ) |
Writes the sample rate. This is a different eeprom location depending on the sampling mode.
rate | The WirelessTypes::WirelessSampleRate to set. |
samplingMode | The WirelessTypes::SamplingMode to set unlimited duration for. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to write the value to the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
WirelessTypes::WirelessSampleRate read_sampleRate( |
| ) const |
Reads the current sample rate set on the Node. This is a different eeprom location depending on the sampling mode.
samplingMode | The WirelessTypes::SamplingMode to get the unlimited duration flag for. |
A WirelessTypes::WirelessSampleRate representing the sample rate that is currently set on the Node.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_dataFormat( |
| ) |
Writes the data format to the Node.
dataFormat | The WirelessTypes::DataFormat to set. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to write the value to the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Reads the current data format set on the Node.
The WirelessTypes::DataFormat that is currently set on the Node.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_collectionMode( |
| ) |
Writes the data collection mode to the Node.
collectionMode | The WirelessTypes::DataCollectionMethod to set. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to write the value to the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Reads the current data collection mode set on the Node.
The WirelessTypes::DataCollectionMethod that is currently set on the Node.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_syncSamplingMode( |
| ) |
Writes the sync sampling mode to the Node.
syncMode | The WirelessTypes::SyncSamplingMode to set. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to write the value to the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Reads the current sync sampling mode set on the Node.
The WirelessTypes::SyncSamplingMode that is currently set on the Node.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_samplingDelay( |
| ) |
Writes the sampling delay to the Node.
delay | The TimeSpan representing the sampling delay to write to the Node. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to write the value to the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Reads the current sampling delay set on the Node.
A TimeSpan representing the sampling delay that is currently set on the Node.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_retransmission( |
| ) |
Writes the retransmission option to the Node.
reTx | The WirelessTypes::NodeRetransmission to write to the Node. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to write the value to the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Reads the current retransmission option set on the Node.
The WirelessTypes::NodeRetransmission representing the retransmission option that is currently set on the Node.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_settlingTime( |
| ) |
Writes the settling time to the Node for the given ChannelMask.
mask const ChannelMask& | The ChannelMask to set the filter setting time for. |
settlingTime | The WirelessTypes::SettlingTime to write to the Node. |
Error_NotSupported: Filter Settling Time is not supported for the given ChannelMask or Node.
Error_NodeCommunication: Failed to write the value to the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
WirelessTypes::SettlingTime read_settlingTime( |
| ) const |
Reads the current filter settling time on the Node for the given ChannelMask.
mask const ChannelMask& | The ChannelMask to read the filter settling time for. |
The WirelessTypes::SettlingTime representing the settling time that is currently set on the Node.
Error_NotSupported: Filter Settling Time is not supported for the given ChannelMask or Node.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_timeBetweenBursts( |
| ) |
Writes the time between each burst to the Node. This function assumes the time between bursts value has been normalized.
timespan const TimeSpan& | The TimeSpan representing the time between each burst. This can be in the range of 1 second to 24 hours. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to write the value to the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Reads the time between each burst from the Node.
The TimeSpan representing the time between each burst.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_samplingMode( |
| ) |
Writes the WirelessTypes::SamplingMode to the Node.
samplingMode | The WirelessTypes::SamplingMode to write to the Node. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to write the value to the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Reads the current WirelessTypes::SamplingMode from the Node.
A WirelessTypes::SamplingMode object representing the sampling mode.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_channelLinearEquation( |
| ) |
Writes the slope and offset for the specified ChannelMask on the Node.
mask const ChannelMask& | The ChannelMask to write the linear equation for. |
equation const LinearEquation& | The LinearEquation containing the slope and offset to write. |
Error_NotSupported: Linear Equation is not supported for the given ChannelMask or Node.
Error_NodeCommunication: Failed to write the value to the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void read_channelLinearEquation( |
| ) |
Reads the slope and offset for the specified ChannelMask from the Node.
mask const ChannelMask& | The ChannelMask to read the linear equation for. |
result | The LinearEquation that will hold the result. |
Error_NotSupported: Linear Equation is not supported for the given ChannelMask or Node.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_channelUnit( |
| ) |
Writes the unit for the specified ChannelMask to the Node.
mask const ChannelMask& | The ChannelMask to write the unit for. |
unit | The WirelessTypes::CalCoef_Unit to write to the Node. |
Error_NotSupported: The Unit setting is not supported for the given ChannelMask or Node.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_channelEquation( |
| ) |
Writes the equation id for the specified ChannelMask to the Node.
mask const ChannelMask& | The ChannelMask to write the equation id for. |
equation | The WirelessTypes::CalCoef_EquationType to write to the Node. |
Error_NotSupported: The Equation ID setting is not supported for the given ChannelMask or Node.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_channelUnitAndEquation( |
| ) |
Writes the unit and equation for the specified ChannelMask to the Node.
channelNumber | The channel number to save the configuration to (channel 1 = 1, channel 8 = 8). |
unit | The WirelessTypes::CalCoef_Unit to write to the Node. |
equation | The WirelessTypes::CalCoef_EquationType to write to the Node. |
Error_NotSupported: The Unit / Equation ID setting is not supported for the given ChannelMask or Node.
Error_NodeCommunication: Failed to write the value to the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
WirelessTypes::CalCoef_Unit read_channelUnit( |
| ) const |
Reads the WirelessTypes::CalCoef_Unit for the specified ChannelMask from the Node.
mask const ChannelMask& | The ChannelMask to read the unit for. |
The WirelessTypes::CalCoef_Unit for the given channel.
Error_NotSupported: The Unit setting is not supported for the given ChannelMask or Node.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
WirelessTypes::CalCoef_EquationType read_channelEquation( |
| ) const |
Reads the WirelessTypes::CalCoef_EquationType for the specified channel from the Node. This assumes the channel is supported by the Node.
mask const ChannelMask& | The ChannelMask to read the equation id for. |
The WirelessTypes::CalCoef_EquationType for the given channel.
Error_NotSupported: The Equation ID setting is not supported for the given ChannelMask or Node.
Error_NodeCommunication: Failed to read the value from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Reads the WirelessTypes::TransmitPower that is currently set on the Node.
The WirelessTypes::TransmitPower that is currently set on the Node.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_transmitPower( |
| ) |
Writes the WirelessTypes::TransmitPower to the Node.
power | The WirelessTypes::TransmitPower to write to the Node. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to write to the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Reads the user inactivity timeout that is currently set on the Node. This controls how many seconds before the Node goes to sleep when idle.
The user inactivity timeout (in seconds) that is currently set on the Node. Note: A value of 65535 (0xFFFF) disables the inactivity timeout so that the Node never goes to sleep.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_inactivityTimeout( |
| ) |
Writes the user inactivity timeout to the Node. This function assumes the inactivity timeout has already been set to be above the minimum.
timeout uint16 | The user inactivity timeout (in seconds) to write to the Node. Note: A value of 65535 (0xFFFF) disables the inactivity timeout so that the Node never goes to sleep. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to write to the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Reads the check radio interval that is currently set on the Node. This controls how often the node wakes up from sleep to check for commands.
The interval (in seconds) that is currently set on the Node.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_checkRadioInterval( |
| ) |
Writes the check radio interval to the Node. This controls how often the node wakes up from sleep to check for commands. This function assumes the interval is within the acceptable range.
interval uint8 | The check radio interval (in seconds) to write to the Node. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to write to the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Reads the WirelessTypes::DefaultMode that is currently set on the Node.
The default mode that is currently set on the Node.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_defaultMode( |
| ) |
Writes the given WirelessTypes::DefaultMode to the Node.
mode | The WirelessTypes::DefaultMode to write to the Node. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to write to the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Reads the next flash page that to be used for datalogging.
The next flash page that to be used for datalogging.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Reads the byte offset into the log page for the next datalogging session.
The byte offset into the log page for the next datalogging session.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Reads the number of datalog sessions that are currently stored on the Node.
The number of datalog sessions that are stored on the Node.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_txPerGroup( |
| ) |
Writes the transmissions per group to the Node.
txPerGroup uint16 | The number of transmissions per group to write. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_groupSize( |
| ) |
Writes the group size to the Node.
groupSize uint16 | The group size to write. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_tdmaAddress( |
| ) |
Writes the TDMA address to the Node.
address uint16 | The TDMA address to write. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_maxRetransPerBurst( |
| ) |
Writes the max retransmissions per burst to the Node.
maxReTxPerBurst uint16 | The value to write. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to read from the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
double read_hardwareGain( |
| ) const |
Reads the hardware gain for the specified ChannelMask from the Node.
mask const ChannelMask& | The ChannelMask to read the hardware gain for. |
The hardware gain for the given ChannelMask.
Error_NotSupported: Hardware gain is not supported for the given ChannelMask or Node.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
uint16 read_hardwareOffset( |
| ) const |
Reads the hardware offset for the specified ChannelMask from the Node.
mask const ChannelMask& | The ChannelMask to read the hardware offset for. |
The hardware offset for the given ChannelMask.
Error_NotSupported: Hardware offset is not supported for the given ChannelMask or Node.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_hardwareGain( |
| ) |
Writes the hardware gain value for the specified ChannelMask to the Node.
mask const ChannelMask& | The ChannelMask to write the hardware gain for. |
gain double | The hardware gain value to write to the Node. |
Error_NotSupported: Hardware gain is not supported for the given ChannelMask or Node.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_hardwareOffset( |
| ) |
Writes the hardware offset value for the specified ChannelMask to the Node.
mask const ChannelMask& | The ChannelMask to write the hardware offset for. |
gain | The hardware offset value to write to the Node. |
Error_NotSupported: Hardware offset is not supported for the given ChannelMask or Node.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
float read_gaugeFactor( |
| ) const |
Reads the gauge factor for the specified ChannelMask from the Node.
mask const ChannelMask& | The ChannelMask to read the gauge factor for. |
The gauge factor for the given ChannelMask.
Error_NotSupported: Gauge Factor is not supported for the given ChannelMask or Node.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_gaugeFactor( |
| ) |
Writes the gauge factor value for the specified ChannelMask to the Node.
mask const ChannelMask& | The ChannelMask to write the gauge factor for. |
gaugeFactor float | The gauge factor value to write to the Node. |
Error_NotSupported: Gauge Factor is not supported for the given ChannelMask or Node.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
WirelessTypes::ThermocoupleType read_thermoType( |
| ) const |
Reads the WirelessTypes::ThermocoupleType from the Node.
mask const ChannelMask& | The ChannelMask to read the thermocouple type for. |
The WirelessTypes::ThermocoupleType for the given ChannelMask.
Error_NotSupported: Thermocouple Type is not supported for the given ChannelMask or Node.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_thermoType( |
| ) |
Writes the WirelessTypes::ThermocoupleType to the Node. This assumes thermocouple type is supported.
mask const ChannelMask& | The ChannelMask to write the thermocouple type for. |
thermocouple | The WirelessTypes::ThermocoupleType to write to the Node. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void read_activitySense( |
| ) const |
Reads the ActivitySense options from the Node. This assumes activity sense configuration is supported by the Node.
result | Will hold the result of the ActivitySense options read from the Node. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_activitySense( |
| ) |
Writes the ActivitySense options to the Node. This assumes fatigue options configuration is supported by the Node.
options const ActivitySense& | The ActivitySense to write to the Node. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void read_fatigueOptions( |
| ) const |
Reads the FatigueOptions from the Node. This assumes fatigue options configuration is supported by the Node.
result | Will hold the result of the FatigueOptions read from the Node. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_fatigueOptions( |
| ) |
Writes the FatigueOptions to the Node. This assumes fatigue options configuration is supported by the Node.
options const FatigueOptions& | The FatigueOptions to write to the Node. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void read_histogramOptions( |
| ) const |
Reads the HistogramOptions from the Node. This assumes histogram options configuration is supported by the Node.
result | Will hold the result of the HistogramOptions read from the Node. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_histogramOptions( |
| ) |
Writes the HistogramOptions to the Node. This assumes histogram options configuration is supported by the Node and all options are valid.
options const HistogramOptions& | The HistogramOptions to write to the Node. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Clears the Histogram on the Node. This assumes histogram options configuration is supported by the Node.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Reads the lost beacon timeout value from the Node. A value of 0 means the timeout is disabled. This assumes lost beacon timeout is supported by the Node.
The lost beacon timeout in minutes.
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
void write_lostBeaconTimeout( |
| ) |
Writes the lost beacon timeout value, in minutes, to the Node. This assumes the value is within range of a valid value.
minutes uint16 | The lost beacon timeout value in minutes. |
Error_NotSupported: Unsupported eeprom location.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.