BaseStationButton
BaseStationButton

Represents a single button on a BaseStation

Types
Command

Represents the types of commands that a BaseStationButton can perform.

btn_nodeSleep

0  - Puts a Node into sleep mode.

btn_nodeStop

1 - Puts a Node into idle mode by stopping/waking it.

btn_enableBeacon

2 - Enables the Beacon on the BaseStation

btn_disableBeacon

3 - Disable the Beacon on the BaseStation

btn_nodeNonSyncSampling

4 - Starts a Node sampling in Non-Synchronized mode.

btn_nodeSyncSampling

5 - Starts a Node sampling in Synchronized mode.

btn_nodeArmedDatalogging

6 - Starts a Node sampling in Armed Datalogging mode.

btn_cyclePower

7 - Cycles the power on the BaseStation.

btn_disabled

65535 - Disables the button functionality.

UserAction

Represents the user action that can be performed to cause a BaseStationButton to perform its command.

action_shortPress

0 - A Short Press of the button

action_longPress

1 - A Long Press of the button

BaseStationButton
BaseStationButton()

Creates a default constructed BaseStationButton object.

BaseStationButton
BaseStationButton(
Command cmd,
uint16 nodeAddress 0
)

Creates a BaseStationButton object.

Parameters
cmd
Command

The BaseStationButton::Command to set.

nodeAddress
uint16

The node address to target from the button's command, if applicable (defaults to 0, no node).

Variables
m_command
Command m_command

The Command of the button.

m_nodeAddress
uint16 m_nodeAddress

The node address that the button's function pertains to, if applicable.

Functions
command
BaseStationButton::Command command() const

Gets the Command that is currently set in this object.

Returns

A BaseStationButton::Command that is currently set in this object.

command
void command(
Command cmd
)

Sets the Command of this BaseStationButton object.

Parameters
cmd

The BaseStationButton::Command to set.

nodeAddress
uint16 nodeAddress() const

Gets the node address that the button's command targets that is currently set in this object.  This is ignored if the command doesn't pertain to a node.  Note: To target all nodes on the frequency, set the node address to 65535.

Returns

The node address that the button's command targets.

nodeAddress
void nodeAddress(
uint16 address
)

Sets the node address to target from the button's command.  This is ignored if the command doesn't pertain to a node.  Note: To target all nodes on the frequency, set the node address to 65535.

Parameters
address
uint16

The node address to target from the button's command.