libdata-unified-status  1.1.1
Data Structures | Functions
Inclination

Data Structures

struct  unified_status_inclination_t
 Inclination details. More...
 

Functions

int unified_status_read_inclination (const char *st, struct unified_status_inclination_t *out)
 Interpret inclination tag. More...
 
void unified_status_write_inclination (struct membuf_t *buf, const struct unified_status_inclination_t *in)
 Compose a inclination tag. More...
 
int soh_store_get_inclination (const struct soh_store_t *store, struct iso8601_date *timestamp, struct unified_status_inclination_t *inclination)
 Retrieve inclination from persistent store object. More...
 

Detailed Description

Inclinometer reading. An inclinometer's reading is expressed in radians, and will be in the range [-M_PI/2,M_PI/2]. As the value is the result of an analog to digital conversion, it may lie slightly outside this interval. To be useful, an inclinometer has two axes: X and Y.

Function Documentation

◆ unified_status_read_inclination()

int unified_status_read_inclination ( const char *  st,
struct unified_status_inclination_t out 
)

Interpret inclination tag.

Parameters
stPointer to status data (must coincide with start of tag).
[out]outInclination written here.
Return values
0on success.
-1on error.

Interprets inclination tag at st, storing the result in out.

◆ unified_status_write_inclination()

void unified_status_write_inclination ( struct membuf_t *  buf,
const struct unified_status_inclination_t in 
)

Compose a inclination tag.

Parameters
bufBuffer to write result into.
inInclination.

Encodes the inclination in in, appending the result onto buf.

◆ soh_store_get_inclination()

int soh_store_get_inclination ( const struct soh_store_t *  store,
struct iso8601_date *  timestamp,
struct unified_status_inclination_t inclination 
)

Retrieve inclination from persistent store object.

Parameters
storePersistent storage object.
[out]timestampTimestamp of last update. May be 0.
[out]inclinationInclination structure. May be 0.
Return values
0on success.
-1on error (no status information seen).