BaseStationAnalogPair
BaseStationAnalogPair

Represents an Analog Pairing on a BaseStation.

CHANNEL_NOT_FLOAT

A (NaN) value representing that the paired node channel is not transmitting float point values.  The outputVal_0V and outputVal_3V values should be set to this value if not being paired to a channel transmitting floats.

BaseStationAnalogPair
BaseStationAnalogPair()

Creates a default constructed BaseStationAnalogPair object.

Float
static BaseStationAnalogPair Float(
uint16 nodeAddress,
uint8 nodeChannel,
float output_0V,
float output_3V
)

Creates a BaseStationAnalogPair object to be paired to WirelessNode's channel that is transmitting floating point values.

Parameters
nodeAddress
uint16

The node address to pair to.

nodeChannel
uint8

The node's channel number to pair to.

output_0V
float

The floating point value that represents 0 volt output.

output_3V
float

The floating point value that represents 3 volt output.

Returns

A BaseStationAnalogPair object created with the specified parameters.

NonFloat
static BaseStationAnalogPair NonFloat(
uint16 nodeAddress,
uint8 nodeChannel
)

Creates a BaseStationAnalogPair object to be paired to WirelessNode's channel that is NOT transmitting floating point values.

Parameters
nodeAddress
uint16

The node address to pair to.

nodeChannel
uint8

The node's channel number to pair to.

Returns

A BaseStationAnalogPair object created with the specified parameters.

nodeAddress
uint16 nodeAddress() const

Gets the node address to be paired with that is currently set in this object.

Returns

The node address to be paired with that is currently set in this object.

nodeAddress
void nodeAddress(
uint16 address
)

Sets the node address of the WirelessNode to be paired with.

Parameters
address
uint16

The node address to be paired with.

nodeChannel
uint8 nodeChannel() const

Gets the node's channel to be paired with that is currently set in this object.

Returns

The node's channel to be paired with that is currently set in this object.

nodeChannel
void nodeChannel(
uint8 channelNumber
)

Sets the node's channel of the WirelessNode to be paired with.

Parameters
channelNumber
uint8

The node's channel number (ch1 = 1, ch8 = 8) to be paired with.

floatData
bool expectFloatData() const

Checks whether floating point data is expected in this object.

Returns

True if floating point data is expected, false if it is not.

floatData
void expectFloatData(
bool enable
)

Sets whether floating point data is expected or not.  Note: If enabling, this will set outputVal_0V to 0 and outputVal_3V to 65535. You should update these values accordingly.  Note: If disabling, this will set outputVal_0V and outputVal_3V to CHANNEL_NOT_FLOAT.

Parameters
enable
bool

Whether to enable or disable the expectation for floating point data.

outputVal_0V
float outputVal_0V() const

Gets the output value that represents 0 Volts that is currently set in this object.

Returns

The output value that represents 0 Volts.

outputVal_0V
void outputVal_0V(
float value
)

Sets the output value that represents 0 Volts.  Note: Setting this to a NaN (CHANNEL_NOT_FLOAT) disables the float expectation and sets outputVal_3V to CHANNEL_NOT_FLOAT as well.  Note: If outputVal_3V is set to CHANNEL_NOT_FLOAT when this is called with a real value, outputVal_3V will be updated to (value + 1.0).

Parameters
value
float

The output value to represent 0 Volts.

outputVal_3V
float outputVal_3V() const

Gets the output value that represents 3 Volts that is currently set in this object.

Returns

The output value that represents 3 Volts.

outputVal_3V
void outputVal_3V(
float value
)

Sets the output value that represents 3 Volts.  Note: Setting this to a NaN (CHANNEL_NOT_FLOAT) disables the float expectation and sets outputVal_0V to CHANNEL_NOT_FLOAT as well.  Note: If outputVal_0V is set to CHANNEL_NOT_FLOAT when this is called with a real value, outputVal_0V will be updated to (value - 1.0).

Parameters
value
float

The output value to represent 3 Volts.