> For the complete documentation index, see [llms.txt](https://irnas.gitbook.io/opencollar/-MDJCI9OmpOqWrQzjNIR/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://irnas.gitbook.io/opencollar/-MDJCI9OmpOqWrQzjNIR/firmware/settings-module/settings-types-and-structures.md).

# Settings types and structures

Structures definitions for usage in settings, values, messages and commands. Defined in settings\_types.h file.

`settings_types.h` file contains all structures and enums used in settings module, that are used in subsequent files and do not need to be auto-generated at build time. 

## Enum

#### conversion\_t

enum `conversion_t` defines all possible data types used in settings:

* UINT8\_T = 1, 
* UINT16\_T = 2, 
* UINT32\_T = 3, 
* INT8\_T = 4, 
* INT16\_T = 5, 
* INT32\_T = 6, 
* FLOAT = 7, 
* BYTE\_ARRAY = 8, 
* BOOL = 9

#### hw\_type

`hw_type` defines all possible HW versions that are supported. 

* wisentedge\_nrf52840 = 1

#### fw\_type

`fw_type` defines all possible FW versions that are supported in FW.

* lion\_tracker = 1

## Settings

Structures containing settings governing settings, values, messages and commands communication and fields. Mainly containing port number for specific type.

* **`fw_version`**
  * major
  * minor
* **`hw_version`**
  * `hw_type` (enum)
  * major
  * minor
* **`settings_defines`** - settings for basic settings values
  * port
  * `fw_type`
* **`advanced_settings`** - settings for advanced settings values
  * port
* **`commands_settings`**
  * port
* **`values_settings`**
  * port

## Values

Definitions of structs holding values and settings of certain types:

* `value_uint8`
* `value_uint16`
* `value_uint32`
* `value_int8`
* `value_int16`
* `value_int32`
* `value_float`
* `value_byte_array`
* `value_bool`

Each structure is of the same format containing:

* `uint8_t id` - id of setting or value
* `bool enabled` - is setting or value enabled
* `def_val` - default value of certain type
* `min` - min value of certain type
* `max` - max value of certain type
* `uint8_t len` - length of type in bytes 
* `conversion_t conversion` - data type

Note that float values are stored as `int16_t array[2]` with encoding: 

`array[0] = (int16_t) float_val` 

and 

`array[1] = (int16_t) (float_val - array[0]) * 10000`