antenna-switcher-client 0.5.0
Async C++17 client for the antenna-switcher device over the ESPHome native API
Loading...
Searching...
No Matches
Public Types | Static Public Member Functions | Public Attributes | List of all members
antenna_switcher::PlanStep Struct Reference

One step of a plan: either switch to an input, or wait for a delay. More...

#include <client.hpp>

Public Types

enum class  Kind { Input , Delay }
 

Static Public Member Functions

static PlanStep input_step (const int n)
 A step that selects input n (1..10).
 
static PlanStep delay_step (const int value, const TimeUnit unit=TimeUnit::Ms)
 A step that waits value in unit.
 

Public Attributes

enum antenna_switcher::PlanStep::Kind kind = Kind::Input
 
int input = 0
 
int delay = 0
 
TimeUnit unit = TimeUnit::Ms
 

Detailed Description

One step of a plan: either switch to an input, or wait for a delay.

Member Enumeration Documentation

◆ Kind

Enumerator
Input 
Delay 

Member Function Documentation

◆ delay_step()

static PlanStep antenna_switcher::PlanStep::delay_step ( const int  value,
const TimeUnit  unit = TimeUnit::Ms 
)
inlinestatic

A step that waits value in unit.

◆ input_step()

static PlanStep antenna_switcher::PlanStep::input_step ( const int  n)
inlinestatic

A step that selects input n (1..10).

Member Data Documentation

◆ delay

int antenna_switcher::PlanStep::delay = 0

◆ input

int antenna_switcher::PlanStep::input = 0

◆ kind

enum antenna_switcher::PlanStep::Kind antenna_switcher::PlanStep::kind = Kind::Input

◆ unit

TimeUnit antenna_switcher::PlanStep::unit = TimeUnit::Ms

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