XDK API  3.6.0
Documentation
Data Structures | Macros | Typedefs | Functions
BleHealthThermometer_Service.h File Reference
#include "bleTypes.h"
+ Include dependency graph for BleHealthThermometer_Service.h:

Data Structures

struct  BleHealthThermometerTemperature
 

Macros

#define BLE_HEALTHTHERMOMETER_STATIC_TEMPERATURETYPE   1
 
#define BLE_HEALTHTHERMOMETER_SUPPORT_TEMPERATURETYPE   0
 
#define BLE_HEALTHTHERMOMETER_SUPPORT_TIMESTAMP   0
 
#define BLE_SUPPORT_HEALTHTHERMOMETER_SERVICE   0
 
#define BLEHEALTHTHERMOMETER_TYPE_ARMPIT   0x01
 
#define BLEHEALTHTHERMOMETER_TYPE_BODY   0x02
 
#define BLEHEALTHTHERMOMETER_TYPE_EAR   0x03
 
#define BLEHEALTHTHERMOMETER_TYPE_FINGER   0x04
 
#define BLEHEALTHTHERMOMETER_TYPE_GASTROINTESTINAL   0x05
 
#define BLEHEALTHTHERMOMETER_TYPE_MOUTH   0x06
 
#define BLEHEALTHTHERMOMETER_TYPE_RECTUM   0x07
 
#define BLEHEALTHTHERMOMETER_TYPE_TOE   0x08
 
#define BLEHEALTHTHERMOMETER_TYPE_TYMPANUM   0x09
 
#define BLEINFOTYPE_HEALTHTHERMOMETER_CLIENTCONFIG   0x50
 

Typedefs

typedef U8 BleHealthThermometerTemperatureType
 

Functions

BleStatus BLEHEALTHTHERMOMETER_SetTemperature (BleHealthThermometerTemperature *temperature)
 

Macro Definition Documentation

#define BLE_HEALTHTHERMOMETER_STATIC_TEMPERATURETYPE   1

BLE_HEALTHTHERMOMETER_STATIC_TEMPERATURETYPE

Defines if the Temperature type is static over the temperature measurement (BLE_HEALTHTHERMOMETER_STATIC_TEMPERATURETYPE set to 1) or not (BLE_HEALTHTHERMOMETER_STATIC_TEMPERATURETYPE set to 0).

There are two exclusive methods to enable a Thermometer to provide temperature type information to a Collector. Either one method or the other is used, but not both. The BLE_HEALTHTHERMOMETER_STATIC_TEMPERATURETYPE is intended to be enabled when the value is static while in a connection. For temperature type values that are non-static while in a connection (e.g. configured using a switch or a simple user interface on a thermometer), the Temperature Type field in the Temperature Measurement characteristic (refer to Section 3.1) shall be provided, so it will add the measurement type within each temperature mesurement.

if BLE_HEALTHTHERMOMETER_STATIC_TEMPERATURETYPE is enabled (1), the BLEHEALTHTHERMOMETER_SetMeasurementType API will be enabled to allow the application to change the type when not connected.

If BLE_HEALTHTHERMOMETER_STATIC_TEMPERATURETYPE is disabled (0), the BleHealthThermometerTemperature structure passed to BLEHEALTHTHERMOMETER_SetTemperature contains the measurementType field.

If the thermometer is for general use, a value of 0x02 Body (general) may be used.

The default value for this option is enabled (1).

#define BLE_HEALTHTHERMOMETER_SUPPORT_TEMPERATURETYPE   0

BLE_HEALTHTHERMOMETER_SUPPORT_TEMPERATURETYPE The temperature type describes the type of temperature measurement in relation to the location on the human body at which the temperature was measured. If The temperature type if supported, it can be populated to the collector using two exclusive methods (staticaly -default- or dynamicaly over a connection).

The default value for this option is disabled (0).

#define BLE_HEALTHTHERMOMETER_SUPPORT_TIMESTAMP   0

BLE_HEALTHTHERMOMETER_SUPPORT_TIMESTAMP The Time Stamp field shall be included in the Temperature Measurement characteristic if the device supports storing of data. Otherwise it is optional. If a time stamp is supported, the thermometer includes the Time Stamp in the Temperature Measurement characteristic. The value of the Time Stamp field is derived from a source of date and time at the time of measurement. If the Time Stamp feature is supported, a source of date and time is mandatory.

if BLE_HEALTHTHERMOMETER_SUPPORT_TIMESTAMP is enabled (1), the BleHealthThermometerTemperature structure passed to BLEHEALTHTHERMOMETER_SetTemperature contains the TimeStamp field.

The default value for this option is disabled (0).

#define BLE_SUPPORT_HEALTHTHERMOMETER_SERVICE   0

BLE_SUPPORT_HEALTHTHERMOMETER_SERVICE Defines if the BLE local device enables access to the local Health Thermometer service and characteristic.

If enabled ( set to 1 ) it enables Profiles to get access to the Health Thermometer Service and characteristic

The default value for this option is disabled (0).

#define BLEHEALTHTHERMOMETER_TYPE_ARMPIT   0x01
#define BLEHEALTHTHERMOMETER_TYPE_BODY   0x02
#define BLEHEALTHTHERMOMETER_TYPE_EAR   0x03
#define BLEHEALTHTHERMOMETER_TYPE_FINGER   0x04
#define BLEHEALTHTHERMOMETER_TYPE_GASTROINTESTINAL   0x05
#define BLEHEALTHTHERMOMETER_TYPE_MOUTH   0x06
#define BLEHEALTHTHERMOMETER_TYPE_RECTUM   0x07
#define BLEHEALTHTHERMOMETER_TYPE_TOE   0x08
#define BLEHEALTHTHERMOMETER_TYPE_TYMPANUM   0x09
#define BLEINFOTYPE_HEALTHTHERMOMETER_CLIENTCONFIG   0x50

Typedef Documentation

BleHealthThermometerTemperatureType type Define the different kind of temperature type that could be set in the BLEHEALTHTHERMOMETER_SetTemperature or BLEHEALTHTHERMOMETER_SetTemperatureType API it is one of the BLEHEALTHTHERMOMETER_TYPE_* defined below

Function Documentation

BleStatus BLEHEALTHTHERMOMETER_SetTemperature ( BleHealthThermometerTemperature temperature)

Set the current temperature

BLEHEALTHTHERMOMETER_SetTemperature() This function is used to set the current temperature characteristic value

BLE_SUPPORT_HEALTHTHERMOMETER_SERVICE shall be enabled.

Parameters
temperature: the structure representing the temperature measurement
Returns
The status of the operation:
  • BLESTATUS_SUCCESS indicates that the operation succeeded.
  • BLESTATUS_FAILED indicates that the operation has failed.

if BLE_PARMS_CHECK is set to 1:

  • BLESTATUS_INVALID_PARMS indicates that the function has failed because an invalid parameter.
Author
Alexandre GIMARD

All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:41 by doxygen 1.8.8