anjay
Data Fields
anjay_ipso_v2_3d_sensor_meta_struct Struct Reference

#include <ipso_objects_v2.h>

Data Fields

const char * unit
 
bool y_axis_present
 
bool z_axis_present
 
bool min_max_measured_value_present
 
double min_range_value
 
double max_range_value
 

Detailed Description

Experimental:
This is experimental IPSO object v2 API. This API can change in future versions without any notice.

IPSO three-axis sensor object instance metadata.

Field Documentation

◆ max_range_value

double max_range_value

The maximum value that can be measured by the sensor.

If the value is NaN the resource won't be created.

◆ min_max_measured_value_present

bool min_max_measured_value_present

Set to true to enable:

  • "Min X Value", "Max X Value",
  • "Min Y Value", "Max Y Value" (if y_axis_present),
  • "Min Z Value", "Max Z Value" (if z_axis_present),
  • "Reset Min and Max Measured Values"

resources.

◆ min_range_value

double min_range_value

The minimum value that can be measured by the sensor.

If the value is NaN the resource won't be created.

◆ unit

const char* unit

Unit of the measured values.

This value is optional; "Sensor Unit" resource will not be created if this value is set to NULL.

The pointed string won't be copied, so user code must assure that the pointer will remain valid for the lifetime of the object.

◆ y_axis_present

bool y_axis_present

Set to true to enable "Y Value" resource.

◆ z_axis_present

bool z_axis_present

Set to true to enable "Z Value" resource.

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