iot_tsensor.h

Go to the documentation of this file.

/*
 * Common IO - basic V1.0.0
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */
 
#ifndef _IOT_TSENSOR_H_
#define _IOT_TSENSOR_H_
 
#include <stdint.h>
 
#define IOT_TSENSOR_SUCCESS            ( 0 ) 
#define IOT_TSENSOR_INVALID_VALUE      ( 1 ) 
#define IOT_TSENSOR_DISABLED           ( 2 ) 
#define IOT_TSENSOR_CLOSED             ( 3 ) 
#define IOT_TSENSOR_GET_TEMP_FAILED    ( 4 ) 
#define IOT_TSENSOR_SET_FAILED         ( 5 ) 
#define IOT_TSENSOR_NOT_SUPPORTED      ( 6 ) 
typedef enum
{
    eTsensorMinThresholdReached, 
    eTsensorMaxThresholdReached  
} IotTsensorStatus_t;
 
typedef enum
{
    eTsensorSetMinThreshold,   
    eTsensorSetMaxThreshold,   
    eTsensorGetMinThreshold,   
    eTsensorGetMaxThreshold,   
    eTsensorPerformCalibration 
} IotTsensorIoctlRequest_t;
 
struct IotTsensorDescriptor;
 
typedef struct IotTsensorDescriptor * IotTsensorHandle_t;
 
typedef void ( * IotTsensorCallback_t)( IotTsensorStatus_t xStatus,
                                        void * pvUserContext );
 
IotTsensorHandle_t iot_tsensor_open( int32_t lTsensorInstance );
 
void iot_tsensor_set_callback( IotTsensorHandle_t const xTsensorHandle,
                               IotTsensorCallback_t xCallback,
                               void * pvUserContext );
 
int32_t iot_tsensor_enable( IotTsensorHandle_t const xTsensorHandle );
 
int32_t iot_tsensor_disable( IotTsensorHandle_t const xTsensorHandle );
 
int32_t iot_tsensor_get_temp( IotTsensorHandle_t const xTsensorHandle,
                              int32_t * plTemp );
 
int32_t iot_tsensor_ioctl( IotTsensorHandle_t const xTsensorHandle,
                           IotTsensorIoctlRequest_t xRequest,
                           void * const pvBuffer );
 
int32_t iot_tsensor_close( IotTsensorHandle_t const xTsensorHandle );
 
 
/* end of group iot_tsensor */
 
#endif /* ifndef _IOT_TSENSOR_H_ */