NHS31xx SW API
Signed URL app.spec. messages

Detailed Description

This file describes the application specific commands and responses used in the Signed URL application.

Data Structures

struct  APP_MSG_CMD_SETURL_T
 
struct  APP_MSG_CMD_SETOFFSET_T
 
struct  APP_MSG_CMD_SETRESOLUTION_T
 
struct  APP_MSG_CMD_SETUNIT_T
 
struct  APP_MSG_CMD_SETKEY_T
 
struct  APP_MSG_CMD_LOCK_T
 
struct  APP_MSG_CMD_SETCONFIG_T
 
struct  APP_MSG_RESPONSE_GETCONFIG_T
 

Macros

#define APP_MSG_MAX_LEN_URL   163
 

Enumerations

enum  APP_MSG_ID_T {
  APP_MSG_ID_GETMEASUREMENTS = 0x46,
  APP_MSG_ID_GETCONFIG = 0x48,
  APP_MSG_ID_SETCONFIG = 0x49,
  APP_MSG_ID_MEASURETEMPERATURE = 0x50,
  APP_MSG_ID_START = 0x5A,
  APP_MSG_ID_GETEVENTS = 0x5B,
  APP_MSG_ID_GETPERIODICDATA = 0x5E,
  APP_MSG_ID_COUNT = 7,
  APP_MSG_ID_GETMEASUREMENTS = 0x46,
  APP_MSG_ID_GETCONFIG = 0x48,
  APP_MSG_ID_SETCONFIG = 0x49,
  APP_MSG_ID_MEASURETEMPERATURE = 0x50,
  APP_MSG_ID_START = 0x5A,
  APP_MSG_ID_GETEVENTS = 0x5B,
  APP_MSG_ID_GETACCELCONFIG = 0x5C,
  APP_MSG_ID_SETACCELCONFIG = 0x5D,
  APP_MSG_ID_GETPERIODICDATA = 0x5E,
  APP_MSG_ID_COUNT = 9,
  APP_MSG_ID_GETMEASUREMENTS = 0x46,
  APP_MSG_ID_GETCONFIG = 0x48,
  APP_MSG_ID_SETCONFIG = 0x49,
  APP_MSG_ID_MEASURETEMPERATURE = 0x50,
  APP_MSG_ID_START = 0x5A,
  APP_MSG_ID_GETEVENTS = 0x5B,
  APP_MSG_ID_GETACCELCONFIG = 0x5C,
  APP_MSG_ID_SETACCELCONFIG = 0x5D,
  APP_MSG_ID_GETPERIODICDATA = 0x5E,
  APP_MSG_ID_GETHUMIDITYCONFIG = 0x5F,
  APP_MSG_ID_SETHUMIDITYCONFIG = 0x60,
  APP_MSG_ID_COUNT = 11,
  APP_MSG_ID_SETURL = 0x71,
  APP_MSG_ID_SETOFFSET = 0x72,
  APP_MSG_ID_SETRESOLUTION = 0x73,
  APP_MSG_ID_SETUNIT = 0x74,
  APP_MSG_ID_SETKEY = 0x75,
  APP_MSG_ID_LOCK = 0x77,
  APP_MSG_ID_SETCONFIG = 0x78,
  APP_MSG_ID_GETCONFIG = 0x79
}
 
enum  APP_MSG_TSEN_RESOLUTION_T {
  APP_MSG_TSEN_RESOLUTION_7BITS = 2,
  APP_MSG_TSEN_RESOLUTION_8BITS = 3,
  APP_MSG_TSEN_RESOLUTION_9BITS = 4,
  APP_MSG_TSEN_RESOLUTION_10BITS = 5,
  APP_MSG_TSEN_RESOLUTION_11BITS = 6,
  APP_MSG_TSEN_RESOLUTION_12BITS = 7,
  APP_MSG_TSEN_RESOLUTION_7BITS = 2,
  APP_MSG_TSEN_RESOLUTION_8BITS = 3,
  APP_MSG_TSEN_RESOLUTION_9BITS = 4,
  APP_MSG_TSEN_RESOLUTION_10BITS = 5,
  APP_MSG_TSEN_RESOLUTION_11BITS = 6,
  APP_MSG_TSEN_RESOLUTION_12BITS = 7,
  APP_MSG_TSEN_RESOLUTION_7BITS = 2,
  APP_MSG_TSEN_RESOLUTION_8BITS = 3,
  APP_MSG_TSEN_RESOLUTION_9BITS = 4,
  APP_MSG_TSEN_RESOLUTION_10BITS = 5,
  APP_MSG_TSEN_RESOLUTION_11BITS = 6,
  APP_MSG_TSEN_RESOLUTION_12BITS = 7,
  APP_MSG_TSEN_RESOLUTION_7BITS = 2,
  APP_MSG_TSEN_RESOLUTION_8BITS = 3,
  APP_MSG_TSEN_RESOLUTION_9BITS = 4,
  APP_MSG_TSEN_RESOLUTION_10BITS = 5,
  APP_MSG_TSEN_RESOLUTION_11BITS = 6,
  APP_MSG_TSEN_RESOLUTION_12BITS = 7
}
 

Data Structure Documentation

◆ APP_MSG_CMD_SETURL_T

struct APP_MSG_CMD_SETURL_T
Data Fields
uint8_t len

Length in bytes of the URL. Must be less than or equal to APP_MSG_MAX_LEN_URL

uint8_t url[163]

The URL string. Only provide the domain plus path without the scheme and without the query part. For example: "blank.org/one.two" Does not need to be NUL-terminated. Exactly len bytes will be copied. The unused part at the end of the array - when len is strict less than APP_MSG_MAX_LEN_URL - is ignored.

◆ APP_MSG_CMD_SETOFFSET_T

struct APP_MSG_CMD_SETOFFSET_T
Data Fields
int8_t offset

Offset to add to the measured temperature. Expressed in deci-degrees Celsius. This is a signed value using two's complement. For example:

  • to add 1.2 degrees to each value, set offset to 12 = 0x0C
  • to subtract 2.3 degrees from each value, set offset to -23 = 0xE9

◆ APP_MSG_CMD_SETRESOLUTION_T

struct APP_MSG_CMD_SETRESOLUTION_T
Data Fields
uint8_t resolution

Type: APP_MSG_TSEN_RESOLUTION_T

◆ APP_MSG_CMD_SETUNIT_T

struct APP_MSG_CMD_SETUNIT_T
Data Fields
uint8_t unit

The temperature unit with which to report temperature measurements. The only valid values are:

  • 'C' = 0x43 to indicate Celsius
  • 'F' = 0x46 to indicate Fahrenheit

◆ APP_MSG_CMD_SETKEY_T

struct APP_MSG_CMD_SETKEY_T
Data Fields
uint32_t key[4]

The 16-byte key to be used for hashing calculations.

Warning
Use a different key for each IC. For example, you can use a key derivation function. A secure location containing a single master key can generate unique keys when fed with unique IDs. This allows to regenerate them when needed, avoiding a costly storage.

◆ APP_MSG_CMD_LOCK_T

struct APP_MSG_CMD_LOCK_T
Data Fields
uint8_t lock

A boolean value. Any non-zero value will lock the firmware, preventing any future configuration change.

◆ APP_MSG_CMD_SETCONFIG_T

struct APP_MSG_CMD_SETCONFIG_T
Data Fields
uint32_t currentTime

The absolute current time in epoch seconds.

uint16_t interval

The time between two measurements, set in seconds.

Note
: A value of 0 disables taking measurements: after entering a power save mode, the chip can then only wake up when an NFC field is present.
uint32_t startDelay

Only looked at when interval is strict positive. Time in seconds to wait before the first measurement is made.

  • If equal to 0, a first measurement will be made immediately (at currentTime).
  • The special value APP_MSG_DELAY_START_INDEFINITELY is used to defer the start indefinitely: the configuration will be fully stored, but no measurements will be made. To save battery, the IC will shut down when no NFC field is present; this means the IC cannot keep track of time during that period. Use the command with message id APP_MSG_ID_START to make a first measurement.
  • Any other value will cause the IC to minimize power while still keeping track of time.

Regardless of when the first measurement is taken, subsequent measurements will be spaced interval seconds apart.

uint32_t runningTime

Only looked at when interval is strict positive. Time in seconds to run after the first measurement.

  • A value of 0 indicates to run indefinitely, i.e. until storage is full, until the battery dies, or until a new configuration is given.
  • Any other value gives a hard stop after that many seconds.

For example, with interval equal to 10 and runningTime equal to 42, a total of 5 measurements will be made. When the time expires, the IC will shut down and will no longer keep track of time. All measurements are retained and can be retrieved.

int16_t validMinimum

A validity constraint. The minimum value in deci-Celsius degrees for each measured temperature value.

  • The entire batch of stored samples is considered valid if all samples comply with this constraint.
  • The entire batch of stored samples is considered invalid if one or more samples do not comply with this constraint.
Note
If validMinimum is not less than validMaximum, all samples are considered valid.
int16_t validMaximum

A validity constraint. The minimum value in deci-Celsius degrees for each measured temperature value.

  • The entire batch of stored samples is considered valid if all samples comply with this constraint.
  • The entire batch of stored samples is considered invalid if one or more samples do not comply with this constraint.
Note
If validMinimum is not less than validMaximum, all samples are considered valid.
uint8_t len
See also
APP_MSG_CMD_SETURL_T.len
uint8_t url[163]
See also
APP_MSG_CMD_SETURL_T.url
int8_t offset
See also
APP_MSG_CMD_SETOFFSET_T.offset
uint8_t resolution
See also
APP_MSG_CMD_SETRESOLUTION_T.resolution
uint8_t unit
See also
APP_MSG_CMD_SETUNIT_T.unit
uint32_t key[4]
See also
APP_MSG_CMD_SETKEY_T.key
uint8_t lock
See also
APP_MSG_CMD_LOCK_T.lock

◆ APP_MSG_RESPONSE_GETCONFIG_T

struct APP_MSG_RESPONSE_GETCONFIG_T
Data Fields
uint32_t result

The command result. Only when result equals MSG_OK, the contents below this field are valid.

uint32_t configTime

The value as given by APP_MSG_CMD_SETCONFIG_T.currentTime, with 0 as default value.

uint16_t interval

The value as given by APP_MSG_CMD_SETCONFIG_T.interval, with 0 as default value.

uint32_t startDelay

The value as given by APP_MSG_CMD_SETCONFIG_T.startDelay, with 0 as default value.

uint32_t runningTime

The value as given by APP_MSG_CMD_SETCONFIG_T.runningTime, with 0 as default value.

int16_t validMinimum

The value as given by APP_MSG_CMD_SETCONFIG_T.validMinimum, with 32767 as default value.

int16_t validMaximum

The value as given by APP_MSG_CMD_SETCONFIG_T.validMaximum, with -32768 as default value.

int16_t attainedMinimum

The absolute minimum value of all temperature measurements.

int16_t attainedMaximum

The absolute maximum value of all temperature measurements.

uint16_t count

The number of measurements available.

A sequence number. Indicates the number of times a URL was read out in different NFC sessions.

Note
This value corresponds to the n query argument in the URL.
uint32_t status

A bitmask of OR'd events of type APP_MSG_EVENT_T.

  • Multiple bits indicating a state change can be set simultaneously: in that case, the highest value bit indicates the current state.
  • Multiple bits indicating a failure or achievement can be set simultaneously.
uint32_t startTime

The time in epoch seconds when the first measurement was taken. 0 if no measurement has yet been taken.

uint32_t currentTime

The current time as known by the IC. This may or may not reflect the current absolute time in epoch seconds: The IC may have stopped keeping track of time:

In these cases, currentTime reflects the time since last waking up again after being shut down. In all other cases the epoch time in seconds was given to the IC using a command with message ID APP_MSG_ID_SETCONFIG or APP_MSG_ID_START and the IC kept up to and including now track of time. The value returned here then reflects the current absolute epoch time in seconds.

Note
Using the other fields in this structure the correct type of the value can be deduced. Typical epoch values will also be a lot larger than any running time since a last reset pulse: any value less than configTime indicates logging has stopped and the device went to power-off mode or has experienced a power loss.
uint8_t len
See also
APP_MSG_CMD_SETURL_T.len
uint8_t url[163]
See also
APP_MSG_CMD_SETURL_T.url
int8_t offset
See also
APP_MSG_CMD_SETOFFSET_T.offset
Note
This value corresponds to the o query argument in the URL.
uint8_t resolution
See also
APP_MSG_CMD_SETRESOLUTION_T.resolution
uint8_t unit
See also
APP_MSG_CMD_SETUNIT_T.unit
uint8_t locked
See also
APP_MSG_CMD_LOCK_T.lock
uint8_t id[8]

An identifier guaranteed unique for each IC.

Note
This value corresponds to the i query argument in the URL.
uint16_t temperature

The last measured temperature. The offset is not added. Expressed in deci-degrees with an offset value of -40C. For example:

  • A value of 0 corresponds to -40C.
  • A value of 789 corresponds to -40 + 78.9 = 38.9C
Note
This value corresponds to the t query argument in the URL.

Macro Definition Documentation

◆ APP_MSG_MAX_LEN_URL

#define APP_MSG_MAX_LEN_URL   163

The maximum size of the domain and path, as set and get by APP_MSG_ID_SETURL, APP_MSG_ID_SETCONFIG and APP_MSG_ID_GETCONFIG.

Enumeration Type Documentation

◆ APP_MSG_ID_T

Supported messages

Enumerator
APP_MSG_ID_GETMEASUREMENTS 

0x46
Retrieves (part of) the stored measurements, that were taken after the last APP_MSG_ID_SETCONFIG command.

Parameters
APP_MSG_CMD_GETMEASUREMENTS_T
Returns
MSG_RESPONSE_RESULTONLY_T if the command could not be handled; APP_MSG_RESPONSE_GETMEASUREMENTS_T otherwise.
Note
synchronous command
All temperatures retrieved are within the range [-APP_MSG_MAX_TEMPERATURE; +APP_MSG_MAX_TEMPERATURE]. There is one special value, APP_MSG_TEMPERATURE_PLACEHOLDER_VALUE, that is used to indicate anomalies.
APP_MSG_ID_GETCONFIG 

0x48
Retrieves all configuration parameters regarding temperature and chip behavior, and the number of temperature measurements available.

Parameters
none
Returns
APP_MSG_RESPONSE_GETCONFIG_T
Note
synchronous command
The response of this command will be buffered by the application in addition to being sent out immediately. It will then also be placed in the same NFC message that contains the response for the MSG_ID_GETVERSION command.
APP_MSG_ID_SETCONFIG 

0x49
Sets all configuration parameters regarding temperature and chip behavior, and clears the buffer holding all measurements and events.

Parameters
APP_MSG_CMD_SETCONFIG_T
Returns
MSG_RESPONSE_RESULTONLY_T
Note
synchronous command
APP_MSG_ID_MEASURETEMPERATURE 

0x50
Measures the temperature using the built-in temperature sensor.

Parameters
APP_MSG_CMD_MEASURETEMPERATURE_T
Returns
MSG_RESPONSE_RESULTONLY_T immediately;
If result was equal to MSG_OK, APP_MSG_RESPONSE_MEASURETEMPERATURE_T thereafter. This may take up to 100 ms. This second response must be fetched by issuing a command with MSG_ID_GETRESPONSE.
Note
asynchronous command
APP_MSG_ID_START 

0x5A
Starts logging according to the last given configuration using APP_MSG_ID_SETCONFIG. A first measurement will be taken immediately.

Parameters
none
Returns
MSG_RESPONSE_RESULTONLY_T
Note
synchronous command
APP_MSG_ID_GETEVENTS 

0x5B
Retrieves events logged by the application. Changes in execution state and detection of anomalies are recorded with a full timestamp and are annotations to the logged measurement values.

Parameters
APP_MSG_CMD_GETEVENTS_T
Returns
APP_MSG_RESPONSE_GETEVENTS_T
Note
synchronous command
APP_MSG_ID_GETPERIODICDATA 

0x5E
Retrieves (part of the) data that was taken periodically. No timing information will be provided, as that can be deduced from the sequence and the configuration details - see APP_MSG_ID_GETCONFIG.

Parameters
APP_MSG_CMD_GETPERIODICDATA_T
Returns
MSG_RESPONSE_RESULTONLY_T if the command could not be handled; APP_MSG_RESPONSE_GETPERIODICDATA_T otherwise.
Note
synchronous command
APP_MSG_ID_COUNT 

Number of application specific message IDs. Not to be used as a possible ID. Use this in for loops or to define array sizes.

APP_MSG_ID_GETMEASUREMENTS 

0x46
Retrieves (part of) the stored measurements, that were taken after the last APP_MSG_ID_SETCONFIG command.

Parameters
APP_MSG_CMD_GETMEASUREMENTS_T
Returns
MSG_RESPONSE_RESULTONLY_T if the command could not be handled; APP_MSG_RESPONSE_GETMEASUREMENTS_T otherwise.
Note
synchronous command
All temperatures retrieved are within the range [-APP_MSG_MAX_TEMPERATURE; +APP_MSG_MAX_TEMPERATURE]. There is one special value, APP_MSG_TEMPERATURE_PLACEHOLDER_VALUE, that is used to indicate anomalies.
APP_MSG_ID_GETCONFIG 

0x48
Retrieves all configuration parameters regarding temperature and chip behavior, and the number of temperature measurements available.

Parameters
none
Returns
APP_MSG_RESPONSE_GETCONFIG_T
Note
synchronous command
The response of this command will be buffered by the application in addition to being sent out immediately. It will then also be placed in the same NFC message that contains the response for the MSG_ID_GETVERSION command.
APP_MSG_ID_SETCONFIG 

0x49
Sets all configuration parameters regarding temperature and chip behavior, and clears the buffer holding all measurements and events.

Parameters
APP_MSG_CMD_SETCONFIG_T
Returns
MSG_RESPONSE_RESULTONLY_T
Note
synchronous command
APP_MSG_ID_MEASURETEMPERATURE 

0x50
Measures the temperature using the built-in temperature sensor.

Parameters
APP_MSG_CMD_MEASURETEMPERATURE_T
Returns
MSG_RESPONSE_RESULTONLY_T immediately;
If result was equal to MSG_OK, APP_MSG_RESPONSE_MEASURETEMPERATURE_T thereafter. This may take up to 100 ms. This second response must be fetched by issuing a command with MSG_ID_GETRESPONSE.
Note
asynchronous command
APP_MSG_ID_START 

0x5A
Starts logging according to the last given configuration using APP_MSG_ID_SETCONFIG. A first measurement will be taken immediately.

Parameters
none
Returns
MSG_RESPONSE_RESULTONLY_T
Note
synchronous command
APP_MSG_ID_GETEVENTS 

0x5B
Retrieves events logged by the application. Changes in execution state and detection of anomalies are recorded with a full timestamp and are annotations to the logged measurement values.

Parameters
APP_MSG_CMD_GETEVENTS_T
Returns
APP_MSG_RESPONSE_GETEVENTS_T
Note
synchronous command
APP_MSG_ID_GETACCELCONFIG 

0x5C
Retrieves all configuration parameters regarding acceleration-related detection such as shock and vibration, and the number of acceleration-related events available.

Parameters
none
Returns
APP_MSG_RESPONSE_GETACCELCONFIG_T
Note
synchronous command
APP_MSG_ID_SETACCELCONFIG 

0x5D
Caches all configuration parameters regarding acceleration-related detection. The cached data is stored in volatile memory only. If later, within the same session, a command with ID APP_MSG_ID_SETCONFIG is given, the configuration parameters are used to configure the accelerometer. Then the configuration is copied to non-volatile memory.

Note
Once configured, the configuration can be overwritten by issuing a new command.
This message does not start a monitoring session.
Parameters
APP_MSG_CMD_SETACCELCONFIG_T
Returns
MSG_RESPONSE_RESULTONLY_T
See also
APP_MSG_ID_SETCONFIG
Note
synchronous command
APP_MSG_ID_GETPERIODICDATA 

0x5E
Retrieves (part of the) data that was taken periodically. No timing information will be provided, as that can be deduced from the sequence and the configuration details - see APP_MSG_ID_GETCONFIG.

Parameters
APP_MSG_CMD_GETPERIODICDATA_T
Returns
MSG_RESPONSE_RESULTONLY_T if the command could not be handled; APP_MSG_RESPONSE_GETPERIODICDATA_T otherwise.
Note
synchronous command
APP_MSG_ID_COUNT 

Number of application specific message IDs. Not to be used as a possible ID. Use this in for loops or to define array sizes.

APP_MSG_ID_GETMEASUREMENTS 

0x46
Retrieves (part of) the stored measurements, that were taken after the last APP_MSG_ID_SETCONFIG command.

Parameters
APP_MSG_CMD_GETMEASUREMENTS_T
Returns
MSG_RESPONSE_RESULTONLY_T if the command could not be handled; APP_MSG_RESPONSE_GETMEASUREMENTS_T otherwise.
Note
synchronous command
All temperatures retrieved are within the range [-APP_MSG_MAX_TEMPERATURE; +APP_MSG_MAX_TEMPERATURE]. There is one special value, APP_MSG_TEMPERATURE_PLACEHOLDER_VALUE, that is used to indicate anomalies.
APP_MSG_ID_GETCONFIG 

0x48
Retrieves all configuration parameters regarding temperature and chip behavior, and the number of temperature measurements available.

Parameters
none
Returns
APP_MSG_RESPONSE_GETCONFIG_T
Note
synchronous command
The response of this command will be buffered by the application in addition to being sent out immediately. It will then also be placed in the same NFC message that contains the response for the MSG_ID_GETVERSION command.
APP_MSG_ID_SETCONFIG 

0x49
Sets all configuration parameters regarding temperature and chip behavior, and clears the buffer holding all measurements and events.

Parameters
APP_MSG_CMD_SETCONFIG_T
Returns
MSG_RESPONSE_RESULTONLY_T
Note
synchronous command
APP_MSG_ID_MEASURETEMPERATURE 

0x50
Measures the temperature using the built-in temperature sensor.

Parameters
APP_MSG_CMD_MEASURETEMPERATURE_T
Returns
MSG_RESPONSE_RESULTONLY_T immediately;
If result was equal to MSG_OK, APP_MSG_RESPONSE_MEASURETEMPERATURE_T thereafter. This may take up to 100 ms. This second response must be fetched by issuing a command with MSG_ID_GETRESPONSE.
Note
asynchronous command
APP_MSG_ID_START 

0x5A
Starts logging according to the last given configuration using APP_MSG_ID_SETCONFIG. A first measurement will be taken immediately.

Parameters
none
Returns
MSG_RESPONSE_RESULTONLY_T
Note
synchronous command
APP_MSG_ID_GETEVENTS 

0x5B
Retrieves events logged by the application. Changes in execution state and detection of anomalies are recorded with a full timestamp and are annotations to the logged measurement values.

Parameters
APP_MSG_CMD_GETEVENTS_T
Returns
APP_MSG_RESPONSE_GETEVENTS_T
Note
synchronous command
APP_MSG_ID_GETACCELCONFIG 

0x5C
Retrieves all configuration parameters regarding acceleration-related detection such as shock and vibration, and the number of acceleration-related events available.

Parameters
none
Returns
APP_MSG_RESPONSE_GETACCELCONFIG_T
Note
synchronous command
APP_MSG_ID_SETACCELCONFIG 

0x5D
Caches all configuration parameters regarding acceleration-related detection. The cached data is stored in volatile memory only. If later, within the same session, a command with ID APP_MSG_ID_SETCONFIG is given, the configuration parameters are used to configure the accelerometer. Then the configuration is copied to non-volatile memory.

Note
Once configured, the configuration can be overwritten by issuing a new command.
This message does not start a monitoring session.
Parameters
APP_MSG_CMD_SETACCELCONFIG_T
Returns
MSG_RESPONSE_RESULTONLY_T
See also
APP_MSG_ID_SETCONFIG
Note
synchronous command
APP_MSG_ID_GETPERIODICDATA 

0x5E
Retrieves (part of the) data that was taken periodically. No timing information will be provided, as that can be deduced from the sequence and the configuration details - see APP_MSG_ID_GETCONFIG.

Parameters
APP_MSG_CMD_GETPERIODICDATA_T
Returns
MSG_RESPONSE_RESULTONLY_T if the command could not be handled; APP_MSG_RESPONSE_GETPERIODICDATA_T otherwise.
Note
synchronous command
APP_MSG_ID_GETHUMIDITYCONFIG 

0x5F
Retrieves the configuration parameters for humidity-related measurements.

Parameters
none
Returns
APP_MSG_RESPONSE_GETHUMIDITYCONFIG_T
Note
synchronous command
APP_MSG_ID_SETHUMIDITYCONFIG 

0x60
Sets the configuration parameters for humidity-related measurements.

Warning
The given settings overwrite the previous ones, even when measurements are already ongoing. Advised is to strictly adhere to this order: This sequence is not enforced nor checked for.
Note
This message does not start a monitoring session.
Parameters
APP_MSG_CMD_SETHUMIDITYCONFIG_T
Returns
MSG_RESPONSE_RESULTONLY_T
Note
synchronous command
APP_MSG_ID_COUNT 

Number of application specific message IDs. Not to be used as a possible ID. Use this in for loops or to define array sizes.

APP_MSG_ID_SETURL 

0x71
Provides a new domain and path to use. The query arguments will be appended after this supplied base and path.

Parameters
Header: Sequence of bytes as per the Protocol.
Payload: APP_MSG_CMD_SETURL_T
Returns
MSG_RESPONSE_RESULTONLY_T.
Note
synchronous command
APP_MSG_ID_SETOFFSET 

0x72
Provides an offset to add to each temperature measurement. Use this to compensate for a suboptimal location of the IC.

Parameters
Header: Sequence of bytes as per the Protocol.
Payload: APP_MSG_CMD_SETOFFSET_T
Returns
MSG_RESPONSE_RESULTONLY_T.
Note
synchronous command
APP_MSG_ID_SETRESOLUTION 

0x73
Determines the resolution - and thus also the conversion time - of a single temperature measurement.

Parameters
Header: Sequence of bytes as per the Protocol.
Payload: APP_MSG_CMD_SETRESOLUTION_T
Returns
MSG_RESPONSE_RESULTONLY_T.
Note
synchronous command
APP_MSG_ID_SETUNIT 

0x74
Determines the temperature unit with which to report the measured temperatures.

Parameters
Header: Sequence of bytes as per the Protocol.
Payload: APP_MSG_CMD_SETUNIT_T
Returns
MSG_RESPONSE_RESULTONLY_T.
Note
synchronous command
APP_MSG_ID_SETKEY 

0x75
Provides a key to use to calculate the hashing value with.

Parameters
Header: Sequence of bytes as per the Protocol.
Payload: APP_MSG_CMD_SETKEY_T
Returns
MSG_RESPONSE_RESULTONLY_T.
Note
synchronous command
APP_MSG_ID_LOCK 

0x77
Blocks all future configuration changes. Once locked, all these commands will return an error without making any change:

Warning
Once locked, the IC can not be unlocked.
Parameters
Header: Sequence of bytes as per the Protocol.
Payload: APP_MSG_CMD_LOCK_T
Returns
MSG_RESPONSE_RESULTONLY_T.
Note
synchronous command
APP_MSG_ID_SETCONFIG 

0x78
Provides a new domain and path, an offset, and a key in one command.

Parameters
Header: Sequence of bytes as per the Protocol.
Payload: APP_MSG_CMD_SETCONFIG_T
Returns
MSG_RESPONSE_RESULTONLY_T.
Note
synchronous command
See also
APP_MSG_ID_SETURL
APP_MSG_ID_SETOFFSET
APP_MSG_ID_SETRESOLUTION
APP_MSG_ID_SETUNIT
APP_MSG_ID_SETKEY
APP_MSG_ID_GETCONFIG 

0x79
Retrieves the different parts that make up the full URL in byte format.

Parameters
Header: Sequence of bytes as per the Protocol.
none
Returns
APP_MSG_RESPONSE_GETCONFIG_T
Note
synchronous command

◆ APP_MSG_TSEN_RESOLUTION_T

Possible resolutions for the Temperature Sensor, used in APP_MSG_CMD_SETRESOLUTION_T.resolution

Note
Regardless of the resolution, the accuracy of the sensor is always +-0.3°C between 0°C and 40°C, and +-0.5°C between -40°C to +85°C.
See also
APP_MSG_ID_SETRESOLUTION
Enumerator
APP_MSG_TSEN_RESOLUTION_7BITS 

0x02
7 bits resolution: +-0.8°C; requires a conversion time of 4 ms.

APP_MSG_TSEN_RESOLUTION_8BITS 

0x03
8 bits resolution: +-0.4°C; requires a conversion time of 7 ms.

APP_MSG_TSEN_RESOLUTION_9BITS 

0x04
9 bits resolution: +-0.2°C; requires a conversion time of 14 ms.

APP_MSG_TSEN_RESOLUTION_10BITS 

0x05
10 bits resolution: +-0.1°C; requires a conversion time of 26 ms.

APP_MSG_TSEN_RESOLUTION_11BITS 

0x06
11 bits resolution: +-0.05°C; requires a conversion time of 50 ms.

APP_MSG_TSEN_RESOLUTION_12BITS 

0x07
12 bits resolution: +-0.025°C; requires a conversion time of 100 ms.

APP_MSG_TSEN_RESOLUTION_7BITS 

0x02
7 bits resolution: +-0.8°C; requires a conversion time of 4 ms.

APP_MSG_TSEN_RESOLUTION_8BITS 

0x03
8 bits resolution: +-0.4°C; requires a conversion time of 7 ms.

APP_MSG_TSEN_RESOLUTION_9BITS 

0x04
9 bits resolution: +-0.2°C; requires a conversion time of 14 ms.

APP_MSG_TSEN_RESOLUTION_10BITS 

0x05
10 bits resolution: +-0.1°C; requires a conversion time of 26 ms.

APP_MSG_TSEN_RESOLUTION_11BITS 

0x06
11 bits resolution: +-0.05°C; requires a conversion time of 50 ms.

APP_MSG_TSEN_RESOLUTION_12BITS 

0x07
12 bits resolution: +-0.025°C; requires a conversion time of 100 ms.

APP_MSG_TSEN_RESOLUTION_7BITS 

0x02
7 bits resolution: +-0.8°C; requires a conversion time of 4 ms.

APP_MSG_TSEN_RESOLUTION_8BITS 

0x03
8 bits resolution: +-0.4°C; requires a conversion time of 7 ms.

APP_MSG_TSEN_RESOLUTION_9BITS 

0x04
9 bits resolution: +-0.2°C; requires a conversion time of 14 ms.

APP_MSG_TSEN_RESOLUTION_10BITS 

0x05
10 bits resolution: +-0.1°C; requires a conversion time of 26 ms.

APP_MSG_TSEN_RESOLUTION_11BITS 

0x06
11 bits resolution: +-0.05°C; requires a conversion time of 50 ms.

APP_MSG_TSEN_RESOLUTION_12BITS 

0x07
12 bits resolution: +-0.025°C; requires a conversion time of 100 ms.

APP_MSG_TSEN_RESOLUTION_7BITS 

0x02
7 bits resolution: +-0.8°C; requires a conversion time of 4 ms.

APP_MSG_TSEN_RESOLUTION_8BITS 

0x03
8 bits resolution: +-0.4°C; requires a conversion time of 7 ms.

APP_MSG_TSEN_RESOLUTION_9BITS 

0x04
9 bits resolution: +-0.2°C; requires a conversion time of 14 ms.

APP_MSG_TSEN_RESOLUTION_10BITS 

0x05
10 bits resolution: +-0.1°C; requires a conversion time of 26 ms.

APP_MSG_TSEN_RESOLUTION_11BITS 

0x06
11 bits resolution: +-0.05°C; requires a conversion time of 50 ms.

APP_MSG_TSEN_RESOLUTION_12BITS 

0x07
12 bits resolution: +-0.025°C; requires a conversion time of 100 ms.