main_ubi_sdk v 0.1.3
This is UBI4 documentation
Parameters

Параметр - это единица информации, передаваемая между устройствами. More...

Data Structures

struct  base_parameter_addinfoseg_struct
 Верхнеуровневая структура addinfo (в основном виджета, но не только) More...
 
struct  base_parameter_info_struct
 Дочерняя структура base_parameter_struct, содержит информацию о параметре More...
 
struct  param_addinfo_read_data_table_struct
 
struct  StructArrayAddInfo_struct
 
struct  StructArray_write_item_header_struct
 
struct  dependence_info_struct
 
struct  enable_function_struct
 
struct  base_parameter_pointers_struct
 Дочерняя структура base_parameter_struct, содержит указатели и колбеки More...
 
struct  base_parameter_struct
 Верхнеуровневая струткура декларации параметра More...
 
struct  parameter_consumer_array_struct
 
struct  dependence_info_array_struct
 
struct  parameter_manager_struct
 
struct  parameter_stream_filter_struct
 
struct  external_device_parameter_stream__struct
 

Enumerations

enum  parameter_type_enum {
  PARTE_UNKNOW , PARTE_BOOL_TYPE , PARTE_BOOL_ARRAY_TYPE , PARTE_BOOL_MAP_TYPE ,
  PARTE_INT32_TYPE , PARTE_INT32_ARRAY_TYPE , PARTE_INT32_MAP_TYPE , PARTE_INT16_TYPE ,
  PARTE_INT16_ARRAY_TYPE , PARTE_INT16_MAP_TYPE , PARTE_INT8_TYPE , PARTE_INT8_ARRAY_TYPE ,
  PARTE_INT8_MAP_TYPE , PARTE_UINT32_TYPE , PARTE_UINT32_ARRAY_TYPE , PARTE_UINT32_MAP_TYPE ,
  PARTE_UINT16_TYPE , PARTE_UINT16_ARRAY_TYPE , PARTE_UINT16_MAP_TYPE , PARTE_UINT8_TYPE ,
  PARTE_UINT8_ARRAY_TYPE , PARTE_UINT8_MAP_TYPE , PARTE_FLOAT_TYPE , PARTE_FLOAT_ARRAY_TYPE ,
  PARTE_FLOAT_MAP_TYPE , PARTE_STRUCT_TYPE , PARTE_STRUCT_ARRAY_TYPE , PARTE_STRUCT_MAP_TYPE ,
  PARTE_FIX_LEN_CHAR_TYPE , PARTE_VAR_LEN_CHAR_TYPE , PARTE_FIX_DATA_TRANSFER_TYPE , PARTE_NUM
}
 Тип передаваемого параметра. Содержится в base_parameter_info_struct.type. More...
 
enum  parameter_dependence_type_enum { PDTE_UNKNOW = 0 , PDTE_EXTERNAL_DEVICE_PARAMETER_STREAM }
 
enum  parameter_save_setting_enum { PSSE_DONT_SAVE = 0 , PSSE_SAVE }
 
enum  parameter_synchronization_direction_enum { PSDE_MASTER_TO_SLAVE = 0 , PSDE_SLAVE_TO_MASTER , PSDE_BIDIRECTIONAL , PSDE_BIDIRECTIONAL_TWO_PARAMETERS }
 
enum  parameter_synchronization_type_enum {
  PSTE_READ_ONLY = 0 , PSTE_WRITE_ONLY , PSTE_STREAMING , PSTE_NOTIFICATION ,
  PSTE_READ_WRITE
}
 
enum  parameter_link_type_enum { PLTE_AUTO = 0 , PLTE_DYNAMIC , PLTE_NO_LINK }
 
enum  parameter_limite_type_enum {
  PLTE_LIMIT_NO_LIMIT = 0 , PLTE_LIMIT_BY_TYPE = 1 , PLTE_LIMIT_CUSTOM = 2 , PLTE_LIMIT_100 = 3 ,
  PLTE_LIMIT_NUM
}
 
enum  parameter_request_optimisation_enum { PROE_REGULAR_STREAM = 0 , PROE_ACTIVATED_STREAM = 1 }
 Режим стрима параметра More...
 
enum  parameter_enable_external_stream_enum { PEESE_DEFAULT_STREAM_MODE = 0 , PEESE_ACTIVATED_STREAM = 1 }
 
enum  StructArray_write_command_enum { SAWCE_ERROR = 0 , SAWCE_ITEM_WRITE }
 

Functions

void init_parameter_manager (parameter_manager_struct **param_manager, base_parameter_struct *parameters, uint8_t param_num)
 
void parameter_write_data (parameter_manager_struct *param_manager, uint8_t data_code, uint8_t instance, void *data)
 
void parameter_write_data_obj (parameter_manager_struct *param_manager, base_parameter_struct *param, uint8_t *data)
 
void parameter_write_data_info (parameter_manager_struct *param_manager, base_parameter_info_struct *param_info, void *data)
 
void parameter_write_master_to_slave_simple (base_parameter_struct *param, uint8_t *Data)
 
void parameter_write_master_to_slave_struct_array (base_parameter_struct *param, uint8_t *Data)
 
void parameter_write_master_to_slave_data_transfer (base_parameter_struct *param, uint8_t *Data, uint16_t size)
 
void create_parameter_consumer_array (base_parameter_pointers_struct *param_pointers, uint8_t size)
 
void parameter_add_consumer (base_parameter_pointers_struct *source_param_pointers, base_parameter_struct param)
 
bool parameter_add_dependence (base_parameter_pointers_struct *param_pointers, uint8_t type, uint8_t instance, void *dependence_pointer, uint32_t dependence_size)
 

Detailed Description

Параметр - это единица информации, передаваемая между устройствами.

Enumeration Type Documentation

◆ parameter_dependence_type_enum

Enumerator
PDTE_UNKNOW 
PDTE_EXTERNAL_DEVICE_PARAMETER_STREAM 

◆ parameter_enable_external_stream_enum

Enumerator
PEESE_DEFAULT_STREAM_MODE 
PEESE_ACTIVATED_STREAM 

◆ parameter_limite_type_enum

Enumerator
PLTE_LIMIT_NO_LIMIT 
PLTE_LIMIT_BY_TYPE 
PLTE_LIMIT_CUSTOM 
PLTE_LIMIT_100 
PLTE_LIMIT_NUM 

◆ parameter_link_type_enum

Enumerator
PLTE_AUTO 
PLTE_DYNAMIC 
PLTE_NO_LINK 

◆ parameter_request_optimisation_enum

Режим стрима параметра

Enumerator
PROE_REGULAR_STREAM 

Обычный стрим, включен, не может быть выключен

PROE_ACTIVATED_STREAM 

Активируемый стрим. По умолчанию выключен, но может быть включен с помощью параметра action_request_param_struct

◆ parameter_save_setting_enum

Enumerator
PSSE_DONT_SAVE 
PSSE_SAVE 

◆ parameter_synchronization_direction_enum

Enumerator
PSDE_MASTER_TO_SLAVE 
PSDE_SLAVE_TO_MASTER 
PSDE_BIDIRECTIONAL 
PSDE_BIDIRECTIONAL_TWO_PARAMETERS 

◆ parameter_synchronization_type_enum

Enumerator
PSTE_READ_ONLY 
PSTE_WRITE_ONLY 
PSTE_STREAMING 
PSTE_NOTIFICATION 
PSTE_READ_WRITE 

◆ parameter_type_enum

Тип передаваемого параметра. Содержится в base_parameter_info_struct.type.

Enumerator
PARTE_UNKNOW 
PARTE_BOOL_TYPE 
PARTE_BOOL_ARRAY_TYPE 
PARTE_BOOL_MAP_TYPE 
PARTE_INT32_TYPE 
PARTE_INT32_ARRAY_TYPE 
PARTE_INT32_MAP_TYPE 
PARTE_INT16_TYPE 
PARTE_INT16_ARRAY_TYPE 
PARTE_INT16_MAP_TYPE 
PARTE_INT8_TYPE 
PARTE_INT8_ARRAY_TYPE 
PARTE_INT8_MAP_TYPE 
PARTE_UINT32_TYPE 
PARTE_UINT32_ARRAY_TYPE 
PARTE_UINT32_MAP_TYPE 
PARTE_UINT16_TYPE 
PARTE_UINT16_ARRAY_TYPE 
PARTE_UINT16_MAP_TYPE 
PARTE_UINT8_TYPE 
PARTE_UINT8_ARRAY_TYPE 
PARTE_UINT8_MAP_TYPE 
PARTE_FLOAT_TYPE 
PARTE_FLOAT_ARRAY_TYPE 
PARTE_FLOAT_MAP_TYPE 
PARTE_STRUCT_TYPE 
PARTE_STRUCT_ARRAY_TYPE 
PARTE_STRUCT_MAP_TYPE 
PARTE_FIX_LEN_CHAR_TYPE 
PARTE_VAR_LEN_CHAR_TYPE 
PARTE_FIX_DATA_TRANSFER_TYPE 
PARTE_NUM 

◆ StructArray_write_command_enum

Enumerator
SAWCE_ERROR 
SAWCE_ITEM_WRITE 

Function Documentation

◆ create_parameter_consumer_array()

void create_parameter_consumer_array ( base_parameter_pointers_struct * param_pointers,
uint8_t size )
Here is the caller graph for this function:

◆ init_parameter_manager()

void init_parameter_manager ( parameter_manager_struct ** param_manager,
base_parameter_struct * parameters,
uint8_t param_num )
Here is the call graph for this function:

◆ parameter_add_consumer()

void parameter_add_consumer ( base_parameter_pointers_struct * source_param_pointers,
base_parameter_struct param )
Here is the call graph for this function:
Here is the caller graph for this function:

◆ parameter_add_dependence()

bool parameter_add_dependence ( base_parameter_pointers_struct * param_pointers,
uint8_t type,
uint8_t instance,
void * dependence_pointer,
uint32_t dependence_size )
Here is the call graph for this function:
Here is the caller graph for this function:

◆ parameter_write_data()

void parameter_write_data ( parameter_manager_struct * param_manager,
uint8_t data_code,
uint8_t instance,
void * data )

◆ parameter_write_data_info()

void parameter_write_data_info ( parameter_manager_struct * param_manager,
base_parameter_info_struct * param_info,
void * data )

◆ parameter_write_data_obj()

void parameter_write_data_obj ( parameter_manager_struct * param_manager,
base_parameter_struct * param,
uint8_t * data )

◆ parameter_write_master_to_slave_data_transfer()

void parameter_write_master_to_slave_data_transfer ( base_parameter_struct * param,
uint8_t * Data,
uint16_t size )
Here is the caller graph for this function:

◆ parameter_write_master_to_slave_simple()

void parameter_write_master_to_slave_simple ( base_parameter_struct * param,
uint8_t * Data )
Here is the caller graph for this function:

◆ parameter_write_master_to_slave_struct_array()

void parameter_write_master_to_slave_struct_array ( base_parameter_struct * param,
uint8_t * Data )
Here is the caller graph for this function: