Data Structures | Macros | Typedefs | Functions | Variables
LWM2MObjectMagnetometer.h File Reference

Interface header for LWM2MObjectMagnetometer file. More...

#include <Serval_Lwm2m.h>
+ Include dependency graph for LWM2MObjectMagnetometer.h:
+ This graph shows which files directly or indirectly include this file:

Data Structures

struct  LWM2MObjectMagnetometer_Resource_S
 LWM2M resource data for magnetometer. More...
 

Macros

#define LWM2M_OBJECTID_IPSO_MAGNETOMETER   3314
 LWM2M object id for magnetometer. More...
 
#define MAGNETOMETER_DECLANATIONANGLE   0.0349066
 

Typedefs

typedef struct
LWM2MObjectMagnetometer_Resource_S 
LWM2MObjectMagnetometer_Resource_T
 

Functions

void LWM2MObjectMagnetometer_Disable (void)
 Disable LWM2M object instance to stop providing sensor data. Sets unit to "" and all other values to 0. Function is thread safe, it schedules a job for serval. Execution may therefore be deferred. More...
 
void LWM2MObjectMagnetometer_Enable (float minRangeValue, float maxRangeValue)
 Enable LWM2M object instance to start providing sensor data. Function is thread safe, it schedules a job for serval. Execution may therefore be deferred. More...
 
void LWM2MObjectMagnetometer_Init (void)
 Initialize LWM2M object instance. Must be called before any other function call. More...
 
void LWM2MObjectMagnetometer_SetValues (float x, float y, float z)
 Set values for x-, y-, and z-axis. More...
 

Variables

LWM2MObjectMagnetometer_Resource_T LWM2MObjectMagnetometerResources
 LWM2M resource data for instance 0. More...
 

Macro Definition Documentation

#define LWM2M_OBJECTID_IPSO_MAGNETOMETER   3314
#define MAGNETOMETER_DECLANATIONANGLE   0.0349066

magnetic declanation angle for Waiblingen

Typedef Documentation

Function Documentation

void LWM2MObjectMagnetometer_Disable ( void  )

Refer interface header for description

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void LWM2MObjectMagnetometer_Enable ( float  minRangeValue,
float  maxRangeValue 
)
Parameters
[in]minRangeValueminimum range of value in [uT].
[in]maxRangeValuemaximum range of value in [uT].

Refer interface header for description

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void LWM2MObjectMagnetometer_Init ( void  )

Refer interface header for description

void LWM2MObjectMagnetometer_SetValues ( float  xValue,
float  yValue,
float  zValue 
)

Set values for axis, units in [uT]. Will triggers the sending of a notification, if a values was changed. Function is thread safe, it schedules a job for serval. Execution may therefore be deferred.

Parameters
[in]xvalue of x-axis in [uT]
[in]yvalue of y-axis in [uT]
[in]zvalue of z-axis in [uT]

Refer interface header for description

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Variable Documentation

LWM2MObjectMagnetometer_Resource_T LWM2MObjectMagnetometerResources

This documentation file has been automatically generated on Fri Oct 4 2019 03:47:01 by doxygen 1.8.8