main_ubi_sdk v 0.1.3
This is UBI4 documentation
base_parameter_info_struct Struct Reference

Дочерняя структура base_parameter_struct, содержит информацию о параметре More...

#include <base_parameter.h>

Data Fields

uint8_t ID
 
uint8_t BroadcastID
 
uint8_t DataCode
 
uint8_t DataInstance
 
uint16_t parameter_size
 
uint8_t flag_shift
 
parameter_request_optimisation_enum optimisation_transfer: 1
 
uint8_t optimisation_stream: 6
 
uint8_t enable_external_stream: 1
 
parameter_limite_type_enum value_limit: 8
 
uint8_t init_read: 1
 
uint8_t init_write: 1
 
parameter_synchronization_type_enum synch_type: 3
 
parameter_synchronization_direction_enum synch_direction: 3
 
uint8_t synch_period: 8
 
parameter_type_enum type: 8
 
parameter_save_setting_enum save_in_master: 1
 
parameter_save_setting_enum save_in_slave: 1
 
uint8_t main_consumer: 1
 
parameter_link_type_enum link_type: 5
 
uint8_t additional_info_size
 
uint8_t related_parameter_ID
 
uint8_t related_DataCode
 

Detailed Description

Дочерняя структура base_parameter_struct, содержит информацию о параметре

Field Documentation

◆ additional_info_size

uint8_t additional_info_size

Размер addition_info, количество виджетов (и прочих addinfo сегментов)

◆ BroadcastID

uint8_t BroadcastID

Глобальный id параметра, по которому параметры линкуются между собой.

◆ DataCode

uint8_t DataCode

Список кодов содержится в sdk в hand_parameter_describtion.h (возможно будет больше вариантов в будущем, но сейчас только один файл)

◆ DataInstance

uint8_t DataInstance

◆ enable_external_stream

uint8_t enable_external_stream

◆ flag_shift

uint8_t flag_shift

◆ ID

uint8_t ID

Локальный id параметра. Обычно все id параметров лежат локально в PCE enum в device_parameters.h

◆ init_read

uint8_t init_read

1/0 Вычитывать параметр при включении

◆ init_write

uint8_t init_write

1/0 Записывать параметр при включении

◆ link_type

Тип линковки параметра. (По умолчанию параметры с одинаковым DataCode линкуются между собой)

◆ main_consumer

uint8_t main_consumer

Данный параметр является главным потребителем. Нужно для init read

◆ optimisation_stream

uint8_t optimisation_stream

◆ optimisation_transfer

parameter_request_optimisation_enum optimisation_transfer

bool переменная,

  • PROE_REGULAR_STREAM - обычный стрим,
  • PROE_ACTIVATED_STREAM - стрим по умолчанию выключен, но может быть включен через action_request_param

◆ parameter_size

uint16_t parameter_size

Размер параметра (и буфера parameter_data_p) Из-за особенностей протокола любой параметр размером до 6 байт будет передаваться одинаковым по длине пакетом, так что если есть десяток bool переменных, их стоит упаковать одну переменную, но в целом скорее стоит придерживаться парадигмы - один параметр - одна единица информации

◆ related_DataCode

uint8_t related_DataCode

◆ related_parameter_ID

uint8_t related_parameter_ID

◆ save_in_master

not implemented

◆ save_in_slave

not implemented

◆ synch_direction

Направление синхронизации параметра. Типичное применение MASTER_TO_SLAVE и SLAVE_TO_MASTER

◆ synch_period

uint8_t synch_period

Период синхронизации для sync_type = PSTE_STREAMING. Измеряется в 10мс фреймах. То есть sync_period = 4 даст период опроса 40мс

◆ synch_type

Тип синхронизации параметра. Типичное применение PSTE_STREAMING для отправки данных в сеть, PSTE_WRITE_ONLY для получения данных из сети.

◆ type

Тип переменной. Нужно для отображения виджетов

◆ value_limit


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