Zephyr Scientific Library (zscilib)
Modules | Data Structures | Enumerations
Structs, Enums and Macros

Common structs and macros for working with measuremeets. More...

Modules

 Base Types
 Base measurement types.
 
 Extended Type: Color
 Extended meassurement types for ZSL_MES_TYPE_COLOR.
 
 Extended Type: Light
 Extended measurement types for ZSL_MES_TYPE_LIGHT.
 
 Extended Type: Temperature
 Extended measurement types for ZSL_MES_TYPE_TEMPERATURE.
 
 SI units and scales
 Definitions for SI base, derived and combined units and scales.
 

Data Structures

struct  zsl_mes_header
 
struct  zsl_measurement
 Measurement packet wrapper. More...
 

Enumerations

enum  zsl_mes_format {
  ZSL_MES_FORMAT_NONE = 0,
  ZSL_MES_FORMAT_CBOR = 1
}
 
enum  zsl_mes_encoding {
  ZSL_MES_ENCODING_NONE = 0,
  ZSL_MES_ENCODING_BASE64 = 1,
  ZSL_MES_ENCODING_BASE45 = 2
}
 
enum  zsl_mes_compression {
  ZSL_MES_COMPRESSION_NONE = 0,
  ZSL_MES_COMPRESSION_LZ4 = 1
}
 
enum  zsl_mes_fragment {
  ZSL_MES_FRAGMENT_NONE = 0,
  ZSL_MES_FRAGMENT_PARTIAL = 1,
  ZSL_MES_FRAGMENT_FINAL = 2
}
 
enum  zsl_mes_timestamp {
  ZSL_MES_TIMESTAMP_NONE = 0,
  ZSL_MES_TIMESTAMP_EPOCH_32 = 1,
  ZSL_MES_TIMESTAMP_EPOCH_64 = 2,
  ZSL_MES_TIMESTAMP_UPTIME_MS_32 = 3,
  ZSL_MES_TIMESTAMP_UPTIME_MS_64 = 4,
  ZSL_MES_TIMESTAMP_UPTIME_US_64 = 5
}
 

Detailed Description

Common structs and macros for working with measuremeets.

Enumeration Type Documentation

◆ zsl_mes_compression

Payload compression algorithm used.

Enumerator
ZSL_MES_COMPRESSION_NONE 

No payload compression used.

ZSL_MES_COMPRESSION_LZ4 

LZ4 compression.

Definition at line 174 of file measurement.h.

◆ zsl_mes_encoding

Payload encoding used.

Enumerator
ZSL_MES_ENCODING_NONE 

No encoding used (binary data).

ZSL_MES_ENCODING_BASE64 

BASE64 Encoding (rfc4648).

ZSL_MES_ENCODING_BASE45 

BASE45 Encoding (draft-faltstrom-base45-06).

Definition at line 164 of file measurement.h.

◆ zsl_mes_format

Payload data structure used.

Enumerator
ZSL_MES_FORMAT_NONE 

No data structure (raw C type data).

ZSL_MES_FORMAT_CBOR 

CBOR record(s).

Definition at line 156 of file measurement.h.

◆ zsl_mes_fragment

Packet fragments.

Enumerator
ZSL_MES_FRAGMENT_NONE 

No a fragment (complete payload).

ZSL_MES_FRAGMENT_PARTIAL 

Non-final fragment in a larger payload.

ZSL_MES_FRAGMENT_FINAL 

Final fragment in the larger payload.

Definition at line 182 of file measurement.h.

◆ zsl_mes_timestamp

Optional timestamp format used.

Enumerator
ZSL_MES_TIMESTAMP_NONE 

No timestamp included.

ZSL_MES_TIMESTAMP_EPOCH_32 

32-bit Unix epoch timestamp present.

ZSL_MES_TIMESTAMP_EPOCH_64 

64-bit Unix epoch timestamp present.

ZSL_MES_TIMESTAMP_UPTIME_MS_32 

32-bit millisecond device uptime counter.

ZSL_MES_TIMESTAMP_UPTIME_MS_64 

64-bit millisecond device uptime counter.

ZSL_MES_TIMESTAMP_UPTIME_US_64 

64-bit microsecond device uptime counter.

Definition at line 192 of file measurement.h.