LibDriver CS1237
Loading...
Searching...
No Matches
cs1237 example driver function
cs1237 driver function

cs1237 example driver modules More...

Collaboration diagram for cs1237 example driver function:

Macros

#define CS1237_BASIC_DEFAULT_ADC_RATE   CS1237_ADC_RATE_10HZ
 cs1237 basic example default definition
#define CS1237_BASIC_DEFAULT_CHANNEL   CS1237_CHANNEL_A
#define CS1237_BASIC_DEFAULT_PGA   CS1237_PGA_128

Functions

uint8_t cs1237_basic_init (float reference_voltage_v, int32_t temperature_raw, float temperature_deg)
 basic example init
uint8_t cs1237_basic_deinit (void)
 basic example deinit
uint8_t cs1237_basic_read (double *mv)
 basic example read
uint8_t cs1237_basic_read_temperature (float *degrees)
 basic example read temperature
uint8_t cs1237_basic_wake_up (void)
 basic example wake up
uint8_t cs1237_basic_power_down (void)
 basic example power down

Detailed Description

cs1237 example driver modules

Macro Definition Documentation

◆ CS1237_BASIC_DEFAULT_ADC_RATE

#define CS1237_BASIC_DEFAULT_ADC_RATE   CS1237_ADC_RATE_10HZ

cs1237 basic example default definition

10hz

Definition at line 56 of file driver_cs1237_basic.h.

◆ CS1237_BASIC_DEFAULT_CHANNEL

#define CS1237_BASIC_DEFAULT_CHANNEL   CS1237_CHANNEL_A

channel a

Definition at line 57 of file driver_cs1237_basic.h.

◆ CS1237_BASIC_DEFAULT_PGA

#define CS1237_BASIC_DEFAULT_PGA   CS1237_PGA_128

pga 128

Definition at line 58 of file driver_cs1237_basic.h.

Function Documentation

◆ cs1237_basic_deinit()

uint8_t cs1237_basic_deinit ( void )

basic example deinit

Returns
status code
  • 0 success
  • 1 deinit failed
Note
none

Definition at line 243 of file driver_cs1237_basic.c.

Here is the call graph for this function:

◆ cs1237_basic_init()

uint8_t cs1237_basic_init ( float reference_voltage_v,
int32_t temperature_raw,
float temperature_deg )

basic example init

Parameters
[in]reference_voltage_vreference voltage volt
[in]temperature_rawtemperature raw value
[in]temperature_degtemperature degrees
Returns
status code
  • 0 success
  • 1 init failed
Note
none

Definition at line 51 of file driver_cs1237_basic.c.

Here is the call graph for this function:

◆ cs1237_basic_power_down()

uint8_t cs1237_basic_power_down ( void )

basic example power down

Returns
status code
  • 0 success
  • 1 power down failed
Note
none

Definition at line 285 of file driver_cs1237_basic.c.

Here is the call graph for this function:

◆ cs1237_basic_read()

uint8_t cs1237_basic_read ( double * mv)

basic example read

Parameters
[out]*mvpointer to a mv buffer
Returns
status code
  • 0 success
  • 1 read failed
Note
none

Definition at line 158 of file driver_cs1237_basic.c.

Here is the call graph for this function:

◆ cs1237_basic_read_temperature()

uint8_t cs1237_basic_read_temperature ( float * degrees)

basic example read temperature

Parameters
[out]*degreespointer to a degrees buffer
Returns
status code
  • 0 success
  • 1 read temperature failed
Note
none

Definition at line 181 of file driver_cs1237_basic.c.

Here is the call graph for this function:

◆ cs1237_basic_wake_up()

uint8_t cs1237_basic_wake_up ( void )

basic example wake up

Returns
status code
  • 0 success
  • 1 wake up failed
Note
none

Definition at line 264 of file driver_cs1237_basic.c.

Here is the call graph for this function: