A helper class for reading and writing to a BaseStation'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.
BaseStationEepromHelper( |
| ) |
Creates a BaseStationEepromHelper object with a BaseStation.
basestation | The BaseStation that will be read from and written to. |
Checks that analog pairing is supported and throws an exception if it isn't.
Error_NotSupported: Analog Pairing is not supported.
Reads the WirelessTypes::TransmitPower that is currently set on the BaseStation.
The WirelessTypes::TransmitPower that is currently set on the BaseStation.
Error_Communication: Failed to read from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
void write_transmitPower( |
| ) |
Writes the WirelessTypes::TransmitPower to the BaseStation.
power | The WirelessTypes::TransmitPower to write to the BaseStation. |
Error_Communication: Failed to write to the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
BaseStationButton read_button( |
| ) const |
Reads the current settings for a particular button and action as a BaseStationButton.
buttonNumber | The button number (1 = button 1) to read for. |
action | The BaseStationButton::UserAction to read for. |
The current settings for the button, as a BaseStationButton
Error_NotSupported: Unsupported button number.
Error_Communication: Failed to read from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
void write_button( |
| ) |
Writes the BaseStationButton to the BaseStation for a particular button and action.
buttonNumber uint8 | The button number (1 = button 1) to write for. |
action | The BaseStationButton::UserAction to write for. |
button | The BaseStationButton to write. |
Error_NotSupported: Unsupported button number.
Error_Communication: Failed to read from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
Reads the setting for if analog pairing is enabled.
true if analog pairing is enabled, false otherwise.
Error_NotSupported: Analog Pairing is not supported.
Error_Communication: Failed to read from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
void write_analogPairingEnabled( |
| ) |
Writes the analog pairing enable setting to the BaseStation.
enable bool | Whether to enable analog pairing or not. |
Error_NotSupported: Analog Pairing is not supported.
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.
The time in seconds for analog timeout. If this is 0, timeout is disabled.
Error_NotSupported: Analog Pairing is not supported.
Error_Communication: Failed to read from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
void write_analogTimeoutTime( |
| ) |
Writes the analog timeout time to the BaseStation.
seconds uint16 | The analog timeout time in seconds. If this is 0, timeout will be disabled. |
Error_NotSupported: Analog Pairing is not supported.
Error_Communication: Failed to read from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
Reads the analog timeout voltage.
The analog timeout voltage.
Error_NotSupported: Analog Pairing is not supported.
Error_Communication: Failed to read from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
void write_analogTimeoutVoltage( |
| ) |
Writes the analog timeout voltage to the BaseStation.
voltage float | The analog timeout voltage to write. |
Error_NotSupported: Analog Pairing is not supported.
Error_Communication: Failed to read from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
Reads the setting for if analog exceedance is enabled.
true if analog exceedance is enabled, false otherwise.
Error_NotSupported: Analog Pairing is not supported.
Error_Communication: Failed to read from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
void write_analogExceedanceEnabled( |
| ) |
Writes the analog exceedance enable setting to the BaseStation.
enable bool | Whether to enable analog exceedance or not. |
Error_NotSupported: Analog Pairing is not supported.
Error_Communication: Failed to read from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
BaseStationAnalogPair read_analogPair( |
| ) const |
Reads the current settings for a particular analog pairing as a BaseStationAnalogPair.
portNumber | The port number (1 = port 1) to read for. |
The current analog pairing settings for the port, as a BaseStationAnalogPair
Error_NotSupported: Unsupported port number.
Error_Communication: Failed to read from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
void write_analogPair( |
| ) |
Writes the BaseStationAnalogPair to the BaseStation for a particular port number.
portNumber uint8 | The port number (1 = port 1) to write for. |
pair const BaseStationAnalogPair& | The BaseStationButton to write. |
Error_NotSupported: Unsupported button number.
Error_Communication: Failed to read from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.
Reads the region code from the BaseStation.
The WirelessTypes::RegionCode set on the BaseStation.
Error_Communication: Failed to read from the BaseStation.
Error_Connection: A connection error has occurred with the BaseStation.