Zephyr API Documentation  3.6.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
osdp_cmd_led_params Struct Reference

LED params sub-structure. More...

#include <osdp.h>

Data Fields

uint8_t control_code
 Control code.
 
uint8_t on_count
 The ON duration of the flash, in units of 100 ms.
 
uint8_t off_count
 The OFF duration of the flash, in units of 100 ms.
 
uint8_t on_color
 Color to set during the ON timer (see osdp_led_color_e).
 
uint8_t off_color
 Color to set during the OFF timer (see osdp_led_color_e).
 
uint16_t timer_count
 Time in units of 100 ms (only for temporary mode).
 

Detailed Description

LED params sub-structure.

Part of LED command. See osdp_cmd_led.

Field Documentation

◆ control_code

uint8_t osdp_cmd_led_params::control_code

Control code.

Temporary Control Code:

  • 0 - NOP - do not alter this LED's temporary settings.
  • 1 - Cancel any temporary operation and display this LED's permanent state immediately.
  • 2 - Set the temporary state as given and start timer immediately.

Permanent Control Code:

  • 0 - NOP - do not alter this LED's permanent settings.
  • 1 - Set the permanent state as given.

◆ off_color

uint8_t osdp_cmd_led_params::off_color

Color to set during the OFF timer (see osdp_led_color_e).

◆ off_count

uint8_t osdp_cmd_led_params::off_count

The OFF duration of the flash, in units of 100 ms.

◆ on_color

uint8_t osdp_cmd_led_params::on_color

Color to set during the ON timer (see osdp_led_color_e).

◆ on_count

uint8_t osdp_cmd_led_params::on_count

The ON duration of the flash, in units of 100 ms.

◆ timer_count

uint16_t osdp_cmd_led_params::timer_count

Time in units of 100 ms (only for temporary mode).


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