LibDriver CS1238
Loading...
Searching...
No Matches
driver_cs1238.h
Go to the documentation of this file.
1
36
37#ifndef DRIVER_CS1238_H
38#define DRIVER_CS1238_H
39
40#include <stdio.h>
41#include <stdint.h>
42#include <string.h>
43
44#ifdef __cplusplus
45extern "C"{
46#endif
47
53
58
62#ifndef CS1238_COMMAND_DATA_DELAY
63 #define CS1238_COMMAND_DATA_DELAY 5
64#endif
65
69typedef enum
70{
74
85
89typedef enum
90{
91 CS1238_PGA_1 = 0x00,
92 CS1238_PGA_2 = 0x01,
96
107
111typedef struct cs1238_handle_s
112{
113 uint8_t (*sclk_gpio_init)(void);
114 uint8_t (*sclk_gpio_deinit)(void);
115 uint8_t (*sclk_gpio_write)(uint8_t level);
116 uint8_t (*dout_gpio_init)(void);
117 uint8_t (*dout_gpio_deinit)(void);
118 uint8_t (*dout_gpio_write)(uint8_t level);
119 uint8_t (*dout_gpio_read)(uint8_t *level);
120 void (*delay_us)(uint32_t us);
121 void (*delay_ms)(uint32_t ms);
122 void (*debug_print)(const char *const fmt, ...);
123 uint8_t pga;
124 uint8_t channel;
128 uint8_t inited;
130
146
150
157
164#define DRIVER_CS1238_LINK_INIT(HANDLE, STRUCTURE) memset(HANDLE, 0, sizeof(STRUCTURE))
165
172#define DRIVER_CS1238_LINK_SCLK_GPIO_INIT(HANDLE, FUC) (HANDLE)->sclk_gpio_init = FUC
173
180#define DRIVER_CS1238_LINK_SCLK_GPIO_DEINIT(HANDLE, FUC) (HANDLE)->sclk_gpio_deinit = FUC
181
188#define DRIVER_CS1238_LINK_SCLK_GPIO_WRITE(HANDLE, FUC) (HANDLE)->sclk_gpio_write = FUC
189
196#define DRIVER_CS1238_LINK_DOUT_GPIO_INIT(HANDLE, FUC) (HANDLE)->dout_gpio_init = FUC
197
204#define DRIVER_CS1238_LINK_DOUT_GPIO_DEINIT(HANDLE, FUC) (HANDLE)->dout_gpio_deinit = FUC
205
212#define DRIVER_CS1238_LINK_DOUT_GPIO_WRITE(HANDLE, FUC) (HANDLE)->dout_gpio_write = FUC
213
220#define DRIVER_CS1238_LINK_DOUT_GPIO_READ(HANDLE, FUC) (HANDLE)->dout_gpio_read = FUC
221
228#define DRIVER_CS1238_LINK_DELAY_US(HANDLE, FUC) (HANDLE)->delay_us = FUC
229
236#define DRIVER_CS1238_LINK_DELAY_MS(HANDLE, FUC) (HANDLE)->delay_ms = FUC
237
244#define DRIVER_CS1238_LINK_DEBUG_PRINT(HANDLE, FUC) (HANDLE)->debug_print = FUC
245
249
256
265uint8_t cs1238_info(cs1238_info_t *info);
266
276uint8_t cs1238_set_reference_voltage(cs1238_handle_t *handle, float volt);
277
287uint8_t cs1238_get_reference_voltage(cs1238_handle_t *handle, float *volt);
288
299uint8_t cs1238_set_temperature_calibration_point(cs1238_handle_t *handle, int32_t temperature_raw, float temperature_deg);
300
311uint8_t cs1238_get_temperature_calibration_point(cs1238_handle_t *handle, int32_t *temperature_raw, float *temperature_deg);
312
323uint8_t cs1238_init(cs1238_handle_t *handle);
324
336uint8_t cs1238_deinit(cs1238_handle_t *handle);
337
351uint8_t cs1238_read(cs1238_handle_t *handle, int32_t *raw, double *mv);
352
368uint8_t cs1238_read_temperature(cs1238_handle_t *handle, int32_t *raw, float *degrees);
369
380uint8_t cs1238_wake_up(cs1238_handle_t *handle);
381
392uint8_t cs1238_power_down(cs1238_handle_t *handle);
393
406
419
432
445
457uint8_t cs1238_set_pga(cs1238_handle_t *handle, cs1238_pga_t pga);
458
470uint8_t cs1238_get_pga(cs1238_handle_t *handle, cs1238_pga_t *pga);
471
483uint8_t cs1238_set_channel(cs1238_handle_t *handle, cs1238_channel_t channel);
484
496uint8_t cs1238_get_channel(cs1238_handle_t *handle, cs1238_channel_t *channel);
497
501
508
521uint8_t cs1238_set_command(cs1238_handle_t *handle, uint8_t command, uint8_t config);
522
535uint8_t cs1238_get_command(cs1238_handle_t *handle, uint8_t command, uint8_t *config);
536
548uint8_t cs1238_get_data(cs1238_handle_t *handle, int32_t *data);
549
553
557
558#ifdef __cplusplus
559}
560#endif
561
562#endif
uint8_t cs1238_set_temperature_calibration_point(cs1238_handle_t *handle, int32_t temperature_raw, float temperature_deg)
set temperature calibration point
uint8_t cs1238_read(cs1238_handle_t *handle, int32_t *raw, double *mv)
read voltage
uint8_t cs1238_get_channel(cs1238_handle_t *handle, cs1238_channel_t *channel)
get adc channel
uint8_t cs1238_read_temperature(cs1238_handle_t *handle, int32_t *raw, float *degrees)
read temperature
struct cs1238_handle_s cs1238_handle_t
cs1238 handle structure definition
uint8_t cs1238_wake_up(cs1238_handle_t *handle)
wake up
cs1238_bool_t
cs1238 bool enumeration definition
uint8_t cs1238_set_reference_voltage(cs1238_handle_t *handle, float volt)
set reference voltage
uint8_t cs1238_set_adc_rate(cs1238_handle_t *handle, cs1238_adc_rate_t rate)
set adc rate
uint8_t cs1238_get_pga(cs1238_handle_t *handle, cs1238_pga_t *pga)
get adc pga
cs1238_adc_rate_t
cs1238 adc rate enumeration definition
uint8_t cs1238_info(cs1238_info_t *info)
get chip's information
uint8_t cs1238_init(cs1238_handle_t *handle)
initialize the chip
uint8_t cs1238_set_pga(cs1238_handle_t *handle, cs1238_pga_t pga)
set adc pga
uint8_t cs1238_set_reference_voltage_output(cs1238_handle_t *handle, cs1238_bool_t enable)
enable or disable reference voltage output
struct cs1238_info_s cs1238_info_t
cs1238 information structure definition
uint8_t cs1238_get_adc_rate(cs1238_handle_t *handle, cs1238_adc_rate_t *rate)
get adc rate
uint8_t cs1238_get_reference_voltage_output(cs1238_handle_t *handle, cs1238_bool_t *enable)
get reference voltage output status
uint8_t cs1238_get_temperature_calibration_point(cs1238_handle_t *handle, int32_t *temperature_raw, float *temperature_deg)
get temperature calibration point
uint8_t cs1238_power_down(cs1238_handle_t *handle)
power down
uint8_t cs1238_get_reference_voltage(cs1238_handle_t *handle, float *volt)
get reference voltage
cs1238_pga_t
cs1238 pga enumeration definition
uint8_t cs1238_deinit(cs1238_handle_t *handle)
close the chip
uint8_t cs1238_set_channel(cs1238_handle_t *handle, cs1238_channel_t channel)
set adc channel
cs1238_channel_t
cs1238 channel enumeration definition
@ CS1238_BOOL_FALSE
@ CS1238_BOOL_TRUE
@ CS1238_ADC_RATE_40HZ
@ CS1238_ADC_RATE_1280HZ
@ CS1238_ADC_RATE_10HZ
@ CS1238_ADC_RATE_640HZ
@ CS1238_PGA_2
@ CS1238_PGA_1
@ CS1238_PGA_64
@ CS1238_PGA_128
@ CS1238_CHANNEL_TEMPERATURE
@ CS1238_CHANNEL_B
@ CS1238_CHANNEL_A
@ CS1238_CHANNEL_SHORT_CIRCUIT
uint8_t cs1238_get_command(cs1238_handle_t *handle, uint8_t command, uint8_t *config)
get command
uint8_t cs1238_set_command(cs1238_handle_t *handle, uint8_t command, uint8_t config)
set command
uint8_t cs1238_get_data(cs1238_handle_t *handle, int32_t *data)
get data
cs1238 handle structure definition
int32_t temperature_raw
void(* delay_ms)(uint32_t ms)
uint8_t(* sclk_gpio_deinit)(void)
uint8_t(* dout_gpio_init)(void)
uint8_t(* dout_gpio_write)(uint8_t level)
void(* debug_print)(const char *const fmt,...)
void(* delay_us)(uint32_t us)
uint8_t(* sclk_gpio_init)(void)
uint8_t(* dout_gpio_deinit)(void)
uint8_t(* dout_gpio_read)(uint8_t *level)
uint8_t(* sclk_gpio_write)(uint8_t level)
cs1238 information structure definition
float supply_voltage_max_v
uint32_t driver_version
char manufacturer_name[32]
float supply_voltage_min_v
char chip_name[32]