mirror of
https://github.com/eclipse/upm.git
synced 2025-03-26 02:10:02 +03:00
142 lines
4.2 KiB
C
142 lines
4.2 KiB
C
/*
|
|
* Author: Abhishek Malik <abhishek.malik@intel.com>
|
|
* Copyright (c) 2017 Intel Corporation.
|
|
*
|
|
* 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.
|
|
*/
|
|
#pragma once
|
|
|
|
#include <stdlib.h>
|
|
#include <unistd.h>
|
|
#include <stdio.h>
|
|
#include <string.h>
|
|
|
|
#include "upm.h"
|
|
#include "mraa/i2c.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#define ABP_DEFAULT_ADDRESS 0x28
|
|
#define OUTPUT_10_PERCENT_COUNT 1638
|
|
#define OUTPUT_90_PERCENT_COUNT 14746
|
|
#define ABP_PRESSURE_MAX 5
|
|
#define ABP_PRESSURE_MIN 0
|
|
#define ABP_PRESSURE_HIGH_BYTE_MASK 0x3f
|
|
#define ABP_TEMPERATURE_LOW_BYTE_SHIFT 5
|
|
#define ABP_TEMPERATURE_MASK 0x7ff
|
|
|
|
typedef enum {
|
|
NORMAL_OPERATION = 0,
|
|
COMMAND_MODE,
|
|
STALE_DATA,
|
|
DIAGNOSTIC } ABP_STATUS;
|
|
|
|
/**
|
|
* @file abp.h
|
|
* @library abp
|
|
* @brief C API for the ABP Honeywell Pressure Sensor
|
|
*
|
|
* @include abp.c
|
|
*/
|
|
|
|
typedef struct _abp_context {
|
|
mraa_i2c_context i2c;
|
|
uint8_t i2c_bus_number;
|
|
uint8_t address;
|
|
int abp_pressure_max;
|
|
int abp_pressure_min;
|
|
uint8_t readings[4];
|
|
ABP_STATUS status;
|
|
} *abp_context;
|
|
|
|
/**
|
|
* ABP Initialization function
|
|
*
|
|
* @param bus I2C bus to use
|
|
* @return device context pointer
|
|
*/
|
|
abp_context abp_init(uint8_t bus, uint8_t dev_address);
|
|
|
|
/**
|
|
* ABP Close function
|
|
*
|
|
* @param dev abp_context pointer
|
|
*/
|
|
void abp_close(abp_context dev);
|
|
|
|
/**
|
|
* Function to get the compensated pressure.
|
|
* The datasheet provides a way to calculate the pressure.
|
|
* In order to know the units take a look at the datasheet.
|
|
*
|
|
* @param dev abp_context pointer
|
|
* @return float compensated pressure value
|
|
*/
|
|
float abp_get_pressure(abp_context dev);
|
|
|
|
/**
|
|
* Function to retrieve the compensated temperature values.
|
|
* All ABP seem to calculate temperature in degree Celsius.
|
|
* (The above fact needs to be verified)
|
|
* NOTE: This functionality is not available in all the ABP sensors.
|
|
*
|
|
* @param dev abp_context pointer
|
|
* @return float compensated temperature value
|
|
*/
|
|
float abp_get_temperature(abp_context dev);
|
|
|
|
/**
|
|
* Function to set the max pressure that the sensor
|
|
* can read, can be retrieved from the datasheet, if this function is
|
|
* not explicitly called to the set the max value, then a default max
|
|
* value of 5 will be set.
|
|
*
|
|
* @param dev abp_context pointer
|
|
* @param min int maximum pressure value possible
|
|
*/
|
|
void abp_set_max_pressure(abp_context dev, int max);
|
|
|
|
/**
|
|
* Function to set the min pressure that the sensor
|
|
* can read, can be retrieved from the datasheet, if this function is
|
|
* not explicitly called to the set the min value, then a default min
|
|
* value of 5 will be set.
|
|
*
|
|
* @param dev abp_context pointer
|
|
* @param min int minimum pressure value possible
|
|
*/
|
|
void abp_set_min_pressure(abp_context dev, int min);
|
|
|
|
/**
|
|
* This function has to be called before calling either of the get
|
|
* temperature or get pressure functions. This function updates the
|
|
* device context with the latest values. Not calling this function
|
|
* will lead to stale values.
|
|
*
|
|
* @param dev abp_context pointer
|
|
*/
|
|
upm_result_t abp_update(abp_context dev);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|