BaseStationConfig
BaseStationConfig

Class used for setting the configuration of BaseStations.  Set all the configuration values that you want to change, then verify and apply them to a BaseStation.

See also: BaseStation::applyConfig

BaseStationConfig
BaseStationConfig()

Creates a blank BaseStationConfig.

transmitPower
WirelessTypes::TransmitPower transmitPower() const

Gets the WirelessTypes::TransmitPower value in the Config, if set.

Exceptions
Error_NoData

The requested value has not been set.

transmitPower
void transmitPower(
WirelessTypes::TransmitPower power
)

Sets the WirelessTypes::TransmitPower value in the Config.

buttonLongPress
BaseStationButton buttonLongPress(
uint8 buttonNumber
) const

Gets the BaseStationButton value in the Config for performing a long press on a specific button, if set.

Parameters
buttonNumber
uint8

The button number (1 = button 1) to get the value for.

Exceptions
Error_NoData

The requested button number for long press has not been set.

buttonLongPress
void buttonLongPress(
uint8 buttonNumber,
const BaseStationButton &button
)

Sets the BaseStationButton value in the Config for performing a short press on a specific button.

Parameters
buttonNumber
uint8

The button number (1 = button 1) to set.

button

The BaseStationButton to set.

buttonShortPress
BaseStationButton buttonShortPress(
uint8 buttonNumber
) const

Gets the BaseStationButton value in the Config for performing a short press on a specific button, if set.

Parameters
buttonNumber
uint8

The button number (1 = button 1) to get the value for.

Exceptions
Error_NoData

The requested button number for short press has not been set.

buttonShortPress
void buttonShortPress(
uint8 buttonNumber,
const BaseStationButton &button
)

Sets the BaseStationButton value in the Config for performing a long press on a specific button.

Parameters
buttonNumber
uint8

The button number (1 = button 1) to set.

button

The BaseStationButton to set.

analogPairingEnable
bool analogPairingEnable() const

Gets the Analog Pairing Enabled value in the Config, if set.

Exceptions
Error_NoData

The requested button number for short press has not been set.

analogPairingEnable
void analogPairingEnable(
bool enable
)

Sets the Analog Pairing Enabled value in the Config.  This controls whether all of the other analog pairing settings have any affect.

Parameters
enable
bool

Whether to enable or disable analog pairing in the Config.

analogTimeoutTime
uint16 analogTimeoutTime() const

Gets the Analog Timeout Time value (in seconds) in the Config, if set.  If this is 0, Analog Timeout is disabled.

Exceptions
Error_NoData

The requested button number for short press has not been set.

analogTimeoutTime
void analogTimeoutTime(
uint16 seconds
)

Sets the Analog Timeout Time value (in seconds) in the Config.  If this is 0, Analog Timeout is disabled.

Parameters
seconds
uint16

The analog timeout time in seconds to set.

analogTimeoutVoltage
float analogTimeoutVoltage() const

Gets the Analog Timeout Voltage in the Config, if set.

Exceptions
Error_NoData

The requested button number for short press has not been set.

analogTimeoutVoltage
void analogTimeoutVoltage(
float voltage
)

Sets the Analog Timeout Voltage in the Config.  If this is 0, Analog Timeout is disabled.

Parameters
voltage
float

The voltage to set.

analogExceedanceEnable
bool analogExceedanceEnable()

Gets the Analog Exceedance Enabled value in the Config, if set.

Exceptions
Error_NoData

The requested button number for short press has not been set.

analogExceedanceEnable
void analogExceedanceEnable(
bool enable
)

Sets the Analog Exceedance Enabled value in the Config.

Parameters
enable
bool

Whether to enable or disable analog exceedance in the Config.

analogPairing
BaseStationAnalogPair analogPairing(
uint8 portNumber
) const

Gets the BaseStationAnalogPair value in the Config for the specified port number, if set.

Parameters
portNumber
uint8

The port number (1 = port 1) to get the pairing for.

Exceptions
Error_NoData

The requested port number has not been set.

buttonLongPress

Sets the BaseStationAnalogPair value in the Config for the specified port number.

Parameters
portNumber

The port number (1 = port 1) to set.

pair

The BaseStationAnalogPair to set.