zmod4xxx.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (c) 2024 Renesas Electronics Corporation
 * All Rights Reserved.
 * 
 * This code is proprietary to Renesas, and is license pursuant to the terms and
 * conditions that may be accessed at:
 * https://www.renesas.com/eu/en/document/msc/renesas-software-license-terms-gas-sensor-software
 *****************************************************************************/

#ifndef _ZMOD4XXX_H
#define _ZMOD4XXX_H

#include "zmod4xxx_types.h"

#define ZMOD4XXX_ADDR_PID       (0x00)
#define ZMOD4XXX_ADDR_CONF      (0x20)
#define ZMOD4XXX_ADDR_PROD_DATA (0x26)
#define ZMOD4XXX_ADDR_CMD       (0x93)
#define ZMOD4XXX_ADDR_STATUS    (0x94)
#define ZMOD4XXX_ADDR_TRACKING  (0x3A)

#define ZMOD4XXX_LEN_PID      (2)
#define ZMOD4XXX_LEN_CONF     (6)
#define ZMOD4XXX_LEN_TRACKING (6)

#define HSP_MAX  (8)
#define RSLT_MAX (32)

#define STATUS_SEQUENCER_RUNNING_MASK   (0x80) 
#define STATUS_SLEEP_TIMER_ENABLED_MASK (0x40) 
#define STATUS_ALARM_MASK               (0x20) 
#define STATUS_LAST_SEQ_STEP_MASK       (0x1F) 
#define STATUS_POR_EVENT_MASK           (0x80) 
#define STATUS_ACCESS_CONFLICT_MASK     (0x40) 
#ifdef __cplusplus
extern "C" {
#endif


zmod4xxx_err zmod4xxx_calc_factor(zmod4xxx_conf *conf, uint8_t *hsp,
                                  uint8_t *config);

float zmod4xxx_calc_single_rmox(zmod4xxx_dev_t *dev, uint8_t *adc_result);

zmod4xxx_err zmod4xxx_calc_rmox(zmod4xxx_dev_t *dev, uint8_t *adc_result,
                                float *rmox);

zmod4xxx_err zmod4xxx_check_error_event(zmod4xxx_dev_t *dev);

zmod4xxx_err zmod4xxx_init_measurement(zmod4xxx_dev_t *dev);

zmod4xxx_err zmod4xxx_init_sensor(zmod4xxx_dev_t *dev);

zmod4xxx_err zmod4xxx_null_ptr_check(zmod4xxx_dev_t *dev);

zmod4xxx_err zmod4xxx_prepare_sensor(zmod4xxx_dev_t *dev);

zmod4xxx_err zmod4xxx_read_adc_result(zmod4xxx_dev_t *dev, uint8_t *adc_result);

zmod4xxx_err zmod4xxx_read_rmox(zmod4xxx_dev_t *dev, uint8_t *adc_result,
                                float *rmox);

zmod4xxx_err zmod4xxx_read_sensor_info(zmod4xxx_dev_t *dev);

zmod4xxx_err zmod4xxx_read_status(zmod4xxx_dev_t *dev, uint8_t *status);

zmod4xxx_err zmod4xxx_read_tracking_number(zmod4xxx_dev_t *dev,
                                           uint8_t *track_num);

zmod4xxx_err zmod4xxx_start_measurement(zmod4xxx_dev_t *dev);

zmod4xxx_err zmod4xxx_start_measurement_at(zmod4xxx_dev_t *dev, uint8_t step );

#ifdef __cplusplus
}
#endif


#endif /* _ZMOD4XXX_H */