Represents an Analog Pairing on a BaseStation.
BaseStationAnalogPair( |
| ) |
Creates a BaseStationAnalogPair object with the provided parameters. Note: This constructor is private to enforce using ::Float and ::NonFloat static functions for construction.
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.
Creates a default constructed BaseStationAnalogPair object.
static BaseStationAnalogPair Float( |
| ) |
Creates a BaseStationAnalogPair object to be paired to WirelessNode's channel that is transmitting floating point values.
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. |
A BaseStationAnalogPair object created with the specified parameters.
static BaseStationAnalogPair NonFloat( |
| ) |
Creates a BaseStationAnalogPair object to be paired to WirelessNode's channel that is NOT transmitting floating point values.
nodeAddress uint16 | The node address to pair to. |
nodeChannel uint8 | The node's channel number to pair to. |
A BaseStationAnalogPair object created with the specified parameters.
The node address to pair.
The node's channel to pair.
The floating point value that represents 0 volts, if the node/channel is sending floating point data.
The floating point value that represents 3 volts, if the node/channel is sending floating point data.
Gets the node address to be paired with that is currently set in this object.
The node address to be paired with that is currently set in this object.
void nodeAddress( |
| ) |
Sets the node address of the WirelessNode to be paired with.
address uint16 | The node address to be paired with. |
Gets the node's channel to be paired with that is currently set in this object.
The node's channel to be paired with that is currently set in this object.
void nodeChannel( |
| ) |
Sets the node's channel of the WirelessNode to be paired with.
channelNumber uint8 | The node's channel number (ch1 = 1, ch8 = 8) to be paired with. |
Checks whether floating point data is expected in this object.
True if floating point data is expected, false if it is not.
void expectFloatData( |
| ) |
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.
enable bool | Whether to enable or disable the expectation for floating point data. |
Gets the output value that represents 0 Volts that is currently set in this object.
The output value that represents 0 Volts.
void outputVal_0V( |
| ) |
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).
value float | The output value to represent 0 Volts. |
Gets the output value that represents 3 Volts that is currently set in this object.
The output value that represents 3 Volts.
void outputVal_3V( |
| ) |
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).
value float | The output value to represent 3 Volts. |