MIP_SDK  latest-2-g34f3e39
MicroStrain Communications Library for embedded systems
Public Types | Public Member Functions | Public Attributes | List of all members
mip::commands_3dm::EventTrigger::ThresholdParams Struct Reference

#include <commands_3dm.hpp>

Public Types

enum  Type : uint8_t { Type::WINDOW = 1, Type::INTERVAL = 2 }
 

Public Member Functions

void insert (Serializer &serializer) const
 Serialization. More...
 
void extract (Serializer &serializer)
 

Public Attributes

uint8_t desc_set = 0
 Parameters. More...
 
uint8_t field_desc = 0
 Field descriptor of target data quantity. More...
 
uint8_t param_id = 0
 1-based index of the target parameter within the MIP field. E.g. for Scaled Accel (0x80,0x04) a value of 2 would represent the Y axis. More...
 
Type type = static_cast<Type>(0)
 Determines the type of comparison. More...
 
union {
   double   low_thres
 
   double   int_thres
 
}; 
 
union {
   double   high_thres
 
   double   interval
 
}; 
 

Member Enumeration Documentation

◆ Type

Enumerator
WINDOW 

Window comparison. Trigger is active if low_thres <= value <= high_thres. If the thresholds are reversed, the trigger is active when value < high_thres or value > low_thres.

INTERVAL 

Trigger at evenly-spaced intervals. Normally used with time fields to trigger periodically. Trigger is active when (value % interval) <= int_thres. If the thresholds are reversed (high_thres < low_thres) then the trigger is active when (value % low_thres) > high_thres.

Member Function Documentation

◆ extract()

void mip::commands_3dm::EventTrigger::ThresholdParams::extract ( Serializer serializer)

◆ insert()

void mip::commands_3dm::EventTrigger::ThresholdParams::insert ( Serializer serializer) const

Serialization.

Member Data Documentation

◆ @72

union { ... }

◆ @74

union { ... }

◆ desc_set

uint8_t mip::commands_3dm::EventTrigger::ThresholdParams::desc_set = 0

Parameters.

Descriptor set of target data quantity.

◆ field_desc

uint8_t mip::commands_3dm::EventTrigger::ThresholdParams::field_desc = 0

Field descriptor of target data quantity.

◆ high_thres

double mip::commands_3dm::EventTrigger::ThresholdParams::high_thres

◆ int_thres

double mip::commands_3dm::EventTrigger::ThresholdParams::int_thres

◆ interval

double mip::commands_3dm::EventTrigger::ThresholdParams::interval

◆ low_thres

double mip::commands_3dm::EventTrigger::ThresholdParams::low_thres

◆ param_id

uint8_t mip::commands_3dm::EventTrigger::ThresholdParams::param_id = 0

1-based index of the target parameter within the MIP field. E.g. for Scaled Accel (0x80,0x04) a value of 2 would represent the Y axis.

◆ type

Type mip::commands_3dm::EventTrigger::ThresholdParams::type = static_cast<Type>(0)

Determines the type of comparison.


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