RA Flexible Software Package Documentation  Release v5.3.0

 
rm_mesh_generic_dtt_srv_transtion_time_info_t Struct Reference

#include <rm_mesh_generic_dtt_srv.h>

Data Fields

uint8_t transition_number_of_steps
 
uint8_t transition_step_resolution
 

Detailed Description

The Generic Default Transition Time state determines how long an element shall take to transition from a present state to a new state. This is a 1-octet value that consists of two fields:

  • a 2-bit bit field representing the step resolution
  • a 6-bit bit field representing the number of transition steps.

This mechanism covers a wide range of times that may be required by different applications:

  • For 100 millisecond step resolution, the range is 0 through 6.2 seconds.
  • For 1 second step resolution, the range is 0 through 62 seconds.
  • For 10 seconds step resolution, the range is 0 through 620 seconds (10.5 minutes).
  • For 10 minutes step resolution, the range is 0 through 620 minutes (10.5 hours).

The Generic Default Transition Time is calculated using the following formula: Generic Default Transition Time = Default Transition Step Resolution * Default Transition Number of Steps

Field Documentation

◆ transition_number_of_steps

uint8_t rm_mesh_generic_dtt_srv_transtion_time_info_t::transition_number_of_steps

The Default Transition Step Resolution field is a 2-bit bit field that determines the resolution of the Generic Default Transition Time state.

Value Description
0b00 The Default Transition Step Resolution is 100 milliseconds
0b01 The Default Transition Step Resolution is 1 second
0b10 The Default Transition Step Resolution is 10 seconds
0b11 The Default Transition Step Resolution is 10 minutes

◆ transition_step_resolution

uint8_t rm_mesh_generic_dtt_srv_transtion_time_info_t::transition_step_resolution

The Default Transition Number of Steps field is a 6-bit value representing the number of transition steps.

Value Description
0x00 The Generic Default Transition Time is immediate.
0x01-0x3E The number of steps.
0x3F The value is unknown. The state cannot be set to this value,

| but an element may report an unknown value if a transition is higher than 0x3E | or not determined.


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