LibDriver CS1237
Loading...
Searching...
No Matches
driver_cs1237.h File Reference

driver cs1237 header file More...

#include <stdio.h>
#include <stdint.h>
#include <string.h>
Include dependency graph for driver_cs1237.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  cs1237_handle_s
 cs1237 handle structure definition More...
struct  cs1237_info_s
 cs1237 information structure definition More...

Macros

#define CS1237_COMMAND_DATA_DELAY   5
 cs1237 command data delay definition
#define DRIVER_CS1237_LINK_INIT(HANDLE, STRUCTURE)
 initialize cs1237_handle_t structure
#define DRIVER_CS1237_LINK_SCLK_GPIO_INIT(HANDLE, FUC)
 link sclk_gpio_init function
#define DRIVER_CS1237_LINK_SCLK_GPIO_DEINIT(HANDLE, FUC)
 link sclk_gpio_deinit function
#define DRIVER_CS1237_LINK_SCLK_GPIO_WRITE(HANDLE, FUC)
 link sclk_gpio_write function
#define DRIVER_CS1237_LINK_DOUT_GPIO_INIT(HANDLE, FUC)
 link dout_gpio_init function
#define DRIVER_CS1237_LINK_DOUT_GPIO_DEINIT(HANDLE, FUC)
 link dout_gpio_deinit function
#define DRIVER_CS1237_LINK_DOUT_GPIO_WRITE(HANDLE, FUC)
 link dout_gpio_write function
#define DRIVER_CS1237_LINK_DOUT_GPIO_READ(HANDLE, FUC)
 link dout_gpio_read function
#define DRIVER_CS1237_LINK_DELAY_US(HANDLE, FUC)
 link delay_us function
#define DRIVER_CS1237_LINK_DELAY_MS(HANDLE, FUC)
 link delay_ms function
#define DRIVER_CS1237_LINK_DEBUG_PRINT(HANDLE, FUC)
 link debug_print function

Typedefs

typedef struct cs1237_handle_s cs1237_handle_t
 cs1237 handle structure definition
typedef struct cs1237_info_s cs1237_info_t
 cs1237 information structure definition

Enumerations

enum  cs1237_bool_t { CS1237_BOOL_FALSE = 0x00 , CS1237_BOOL_TRUE = 0x01 }
 cs1237 bool enumeration definition More...
enum  cs1237_adc_rate_t { CS1237_ADC_RATE_10HZ = 0x00 , CS1237_ADC_RATE_40HZ = 0x01 , CS1237_ADC_RATE_640HZ = 0x02 , CS1237_ADC_RATE_1280HZ = 0x03 }
 cs1237 adc rate enumeration definition More...
enum  cs1237_pga_t { CS1237_PGA_1 = 0x00 , CS1237_PGA_2 = 0x01 , CS1237_PGA_64 = 0x02 , CS1237_PGA_128 = 0x03 }
 cs1237 pga enumeration definition More...
enum  cs1237_channel_t { CS1237_CHANNEL_A = 0x00 , CS1237_CHANNEL_TEMPERATURE = 0x02 , CS1237_CHANNEL_SHORT_CIRCUIT = 0x03 }
 cs1237 channel enumeration definition More...

Functions

uint8_t cs1237_info (cs1237_info_t *info)
 get chip's information
uint8_t cs1237_set_reference_voltage (cs1237_handle_t *handle, float volt)
 set reference voltage
uint8_t cs1237_get_reference_voltage (cs1237_handle_t *handle, float *volt)
 get reference voltage
uint8_t cs1237_set_temperature_calibration_point (cs1237_handle_t *handle, int32_t temperature_raw, float temperature_deg)
 set temperature calibration point
uint8_t cs1237_get_temperature_calibration_point (cs1237_handle_t *handle, int32_t *temperature_raw, float *temperature_deg)
 get temperature calibration point
uint8_t cs1237_init (cs1237_handle_t *handle)
 initialize the chip
uint8_t cs1237_deinit (cs1237_handle_t *handle)
 close the chip
uint8_t cs1237_read (cs1237_handle_t *handle, int32_t *raw, double *mv)
 read voltage
uint8_t cs1237_read_temperature (cs1237_handle_t *handle, int32_t *raw, float *degrees)
 read temperature
uint8_t cs1237_wake_up (cs1237_handle_t *handle)
 wake up
uint8_t cs1237_power_down (cs1237_handle_t *handle)
 power down
uint8_t cs1237_set_reference_voltage_output (cs1237_handle_t *handle, cs1237_bool_t enable)
 enable or disable reference voltage output
uint8_t cs1237_get_reference_voltage_output (cs1237_handle_t *handle, cs1237_bool_t *enable)
 get reference voltage output status
uint8_t cs1237_set_adc_rate (cs1237_handle_t *handle, cs1237_adc_rate_t rate)
 set adc rate
uint8_t cs1237_get_adc_rate (cs1237_handle_t *handle, cs1237_adc_rate_t *rate)
 get adc rate
uint8_t cs1237_set_pga (cs1237_handle_t *handle, cs1237_pga_t pga)
 set adc pga
uint8_t cs1237_get_pga (cs1237_handle_t *handle, cs1237_pga_t *pga)
 get adc pga
uint8_t cs1237_set_channel (cs1237_handle_t *handle, cs1237_channel_t channel)
 set adc channel
uint8_t cs1237_get_channel (cs1237_handle_t *handle, cs1237_channel_t *channel)
 get adc channel
uint8_t cs1237_set_command (cs1237_handle_t *handle, uint8_t command, uint8_t config)
 set command
uint8_t cs1237_get_command (cs1237_handle_t *handle, uint8_t command, uint8_t *config)
 get command
uint8_t cs1237_get_data (cs1237_handle_t *handle, int32_t *data)
 get data

Detailed Description

driver cs1237 header file

Copyright (c) 2015 - present LibDriver All rights reserved

The MIT License (MIT)

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.

Version
1.0.0
Author
Shifeng Li
Date
2026-09-30

history

Date Version Author Description
2026/09/30 1.0 Shifeng Li first upload

Definition in file driver_cs1237.h.