libRBR  v1.2.3
RBR instrument communication API
Data Fields
RBRInstrumentWiFi Struct Reference

Instrument wifi command parameters. More...

#include <RBRInstrumentCommunication.h>

Data Fields

bool enabled
 Enables or disables Wi-Fi connectivity. More...
 
const RBRInstrumentWiFiState state
 The state of the Wi-Fi radio. More...
 
int32_t powerTimeout
 How long the instrument will wait for a valid command after first powering up the Wi-Fi radio before powering it back down. More...
 
int32_t commandTimeout
 How long the instrument will wait between commands after the first command before powering down the Wi-Fi radio. More...
 
const RBRInstrumentSerialBaudRate baudRate
 The speed of the internal connection between the instrument's CPU and the Wi-Fi radio. More...
 

Detailed Description

Instrument wifi command parameters.

See also
RBRInstrument_getWiFi()
RBRInstrument_setWiFi()
https://docs.rbr-global.com/L3commandreference/commands/communications/wifi

Field Documentation

◆ baudRate

const RBRInstrumentSerialBaudRate RBRInstrumentWiFi::baudRate

The speed of the internal connection between the instrument's CPU and the Wi-Fi radio.

The corresponding instrument parameter is read-only. This member is used only when reading parameters from the instrument; its value is ignored when sending parameters to the instrument.

This parameter is unavailable for Logger2 instruments. Will be retrieved as RBRINSTRUMENT_SERIAL_BAUD_NONE.

◆ commandTimeout

int32_t RBRInstrumentWiFi::commandTimeout

How long the instrument will wait between commands after the first command before powering down the Wi-Fi radio.

Specified in whole seconds expressed as milliseconds. Must be in the range 5,000—600,000 (5 seconds to 10 minutes).

◆ enabled

bool RBRInstrumentWiFi::enabled

Enables or disables Wi-Fi connectivity.

This parameter is unavailable for Logger2 instruments. Will be retrieved as false.

◆ powerTimeout

int32_t RBRInstrumentWiFi::powerTimeout

How long the instrument will wait for a valid command after first powering up the Wi-Fi radio before powering it back down.

Specified in whole seconds expressed as milliseconds. Must be in the range 5,000—600,000 (5 seconds to 10 minutes).

◆ state

const RBRInstrumentWiFiState RBRInstrumentWiFi::state

The state of the Wi-Fi radio.

The corresponding instrument parameter is read-only. This member is used only when reading parameters from the instrument; its value is ignored when sending parameters to the instrument.

This parameter is unavailable for Logger2 instruments. Will be retrieved as RBRINSTRUMENT_UNKNOWN_WIFI.


The documentation for this struct was generated from the following file: