NHS31xx SW API

Detailed Description

The text functions provide the ability to the Temperature Logger to translate its current status in text form. This allows to create NDEF TEXT records conveying the current state, which in turn allows to demonstrate the NHS31xx capabilities to create NDEF standard messages since they can be parsed and displayed by an NFC-enabled Android phone without the need of a dedicated APP; or by any recent iPhone running a generic NFC APP - such NXP's Tag Info. The text can also be copied and presented as is in any dedicated APP running on the tag reader.

Language is American English.

Macros

#define TEXT_MAX_STATUS_LENGTH   46
 
#define TEXT_MAX_FAILURE_LENGTH   46
 
#define TEXT_MAX_FAILURES_LENGTH   (7 * TEXT_MAX_FAILURE_LENGTH)
 
#define TEXT_MAX_TEMPERATURE_LENGTH   59
 
#define TEXT_MAX_STATUS_LENGTH   46
 
#define TEXT_MAX_FAILURE_LENGTH   46
 
#define TEXT_MAX_FAILURES_LENGTH   (7 * TEXT_MAX_FAILURE_LENGTH)
 
#define TEXT_MAX_TEMPERATURE_LENGTH   59
 
#define TEXT_MAX_HUMIDITY_LENGTH   54
 

Functions

const char * Text_GetStatus (int *pLen)
 
const char * Text_GetFailures (int *pLen)
 
const char * Text_GetTemperature (int *pLen)
 
const char * Text_GetHumidity (int *pLen)
 

Macro Definition Documentation

◆ TEXT_MAX_STATUS_LENGTH [1/2]

#define TEXT_MAX_STATUS_LENGTH   46

The maximum size of the buffer returned by Text_GetStatus

◆ TEXT_MAX_FAILURE_LENGTH [1/2]

#define TEXT_MAX_FAILURE_LENGTH   46

The maximum size of one stringified failure.

◆ TEXT_MAX_FAILURES_LENGTH [1/2]

#define TEXT_MAX_FAILURES_LENGTH   (7 * TEXT_MAX_FAILURE_LENGTH)

The maximum size of the buffer returned by Text_GetFailures

◆ TEXT_MAX_TEMPERATURE_LENGTH [1/2]

#define TEXT_MAX_TEMPERATURE_LENGTH   59

The maximum size of the buffer returned by Text_GetTemperature

◆ TEXT_MAX_STATUS_LENGTH [2/2]

#define TEXT_MAX_STATUS_LENGTH   46

The maximum size of the buffer returned by Text_GetStatus

◆ TEXT_MAX_FAILURE_LENGTH [2/2]

#define TEXT_MAX_FAILURE_LENGTH   46

The maximum size of one stringified failure.

◆ TEXT_MAX_FAILURES_LENGTH [2/2]

#define TEXT_MAX_FAILURES_LENGTH   (7 * TEXT_MAX_FAILURE_LENGTH)

The maximum size of the buffer returned by Text_GetFailures

◆ TEXT_MAX_TEMPERATURE_LENGTH [2/2]

#define TEXT_MAX_TEMPERATURE_LENGTH   59

The maximum size of the buffer returned by Text_GetTemperature

◆ TEXT_MAX_HUMIDITY_LENGTH

#define TEXT_MAX_HUMIDITY_LENGTH   54

The maximum size of the buffer returned by Text_GetTemperature

Function Documentation

◆ Text_GetStatus()

const char * Text_GetStatus ( int *  pLen)

Retrieve a textual representation of the current status.

Parameters
[out]pLen: May not be NULL. The string length in bytes will be written here when the function returns.
Returns
A pointer to a string of *pLen characters, less than or equal to TEXT_MAX_STATUS_LENGTH
Note
The data pointed to remains valid until SRAM is cleared.
Accesses the memory application file (memory.c/h), storage module and event module.

◆ Text_GetFailures()

const char * Text_GetFailures ( int *  pLen)

Retrieve a textual representation of the current failures.

Parameters
[out]pLen: May not be NULL. The string length in bytes will be written here when the function returns.
Returns
A pointer to a string of *pLen characters, less than or equal to (EVENT_TAG_LAST_FAILURE - EVENT_TAG_FIRST_FAILURE + 1) * TEXT_MAX_FAILURE_LENGTH
Note
The data pointed to remains valid until SRAM is cleared.
Accesses the memory application file (memory.c/h) and event module.

◆ Text_GetTemperature()

const char * Text_GetTemperature ( int *  pLen)

Retrieve a textual representation of the current temperature.

Parameters
[out]pLen: May not be NULL. The string length in bytes will be written here when the function returns.
Returns
A pointer to a string of *pLen characters, less than or equal to TEXT_MAX_TEMPERATURE_LENGTH
Note
The data pointed to remains valid until SRAM is cleared.
Accesses the memory application file (memory.c/h).

◆ Text_GetHumidity()

const char* Text_GetHumidity ( int *  pLen)

Retrieve a textual representation of the current humidity.

Parameters
[out]pLen: May not be NULL. The string length in bytes will be written here when the function returns.
Returns
A pointer to a string of *pLen characters, less than or equal to TEXT_MAX_HUMIDITY_LENGTH
Note
The data pointed to remains valid until SRAM is cleared.
Accesses the memory application file (memory.c/h).