LibDriver BA234
Loading...
Searching...
No Matches
ba234 basic driver function
ba234 driver function

ba234 basic driver modules More...

Collaboration diagram for ba234 basic driver function:

Data Structures

struct  ba234_data_s
 ba234 data structure definition More...
struct  ba234_handle_s
 ba234 handle structure definition More...
struct  ba234_info_s
 ba234 information structure definition More...

Macros

#define BA234_READ_TIMEOUT   2000
 ba234 read timeout definition

Typedefs

typedef struct ba234_data_s ba234_data_t
 ba234 data structure definition
typedef struct ba234_handle_s ba234_handle_t
 ba234 handle structure definition
typedef struct ba234_info_s ba234_info_t
 ba234 information structure definition

Enumerations

enum  ba234_status_t { BA234_STATUS_OK = 0x00 , BA234_STATUS_FRAME_ERROR = 0x01 , BA234_STATUS_BUSY = 0x02 , BA234_STATUS_CALIBRATION_ERROR = 0x03 }
 ba234 status enumeration definition More...

Functions

uint8_t ba234_info (ba234_info_t *info)
 get chip's information
uint8_t ba234_init (ba234_handle_t *handle)
 initialize the chip
uint8_t ba234_deinit (ba234_handle_t *handle)
 close the chip
uint8_t ba234_read (ba234_handle_t *handle, ba234_data_t *data)
 read the data
uint8_t ba234_baseline_calibration (ba234_handle_t *handle)
 baseline calibration
uint8_t ba234_salinity_calibration (ba234_handle_t *handle, uint16_t value)
 salinity calibration
uint8_t ba234_get_last_status (ba234_handle_t *handle, ba234_status_t *status)
 get last status
uint8_t ba234_salinity_convert_to_register (ba234_handle_t *handle, float percentage, uint16_t *reg)
 convert the salinity to the register raw data
uint8_t ba234_salinity_convert_to_data (ba234_handle_t *handle, uint16_t reg, float *percentage)
 convert the register raw data to the salinity

Detailed Description

ba234 basic driver modules

Macro Definition Documentation

◆ BA234_READ_TIMEOUT

#define BA234_READ_TIMEOUT   2000

ba234 read timeout definition

2000 ms

Definition at line 63 of file driver_ba234.h.

Typedef Documentation

◆ ba234_data_t

typedef struct ba234_data_s ba234_data_t

ba234 data structure definition

◆ ba234_handle_t

typedef struct ba234_handle_s ba234_handle_t

ba234 handle structure definition

◆ ba234_info_t

typedef struct ba234_info_s ba234_info_t

ba234 information structure definition

Enumeration Type Documentation

◆ ba234_status_t

enum ba234_status_t

ba234 status enumeration definition

Enumerator
BA234_STATUS_OK 

ok

BA234_STATUS_FRAME_ERROR 

frame error

BA234_STATUS_BUSY 

busy

BA234_STATUS_CALIBRATION_ERROR 

calibration error

Definition at line 69 of file driver_ba234.h.

Function Documentation

◆ ba234_baseline_calibration()

uint8_t ba234_baseline_calibration ( ba234_handle_t * handle)

baseline calibration

Parameters
[in]*handlepointer to a ba234 handle structure
Returns
status code
  • 0 success
  • 1 baseline calibration failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 frame error
  • 5 response error
Note
none

Definition at line 353 of file driver_ba234.c.

◆ ba234_deinit()

uint8_t ba234_deinit ( ba234_handle_t * handle)

close the chip

Parameters
[in]*handlepointer to a ba234 handle structure
Returns
status code
  • 0 success
  • 1 uart deinit failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 257 of file driver_ba234.c.

◆ ba234_get_last_status()

uint8_t ba234_get_last_status ( ba234_handle_t * handle,
ba234_status_t * status )

get last status

Parameters
[in]*handlepointer to a ba234 handle structure
[out]*statuspointer to a status buffer
Returns
status code
  • 0 success
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 493 of file driver_ba234.c.

◆ ba234_info()

uint8_t ba234_info ( ba234_info_t * info)

get chip's information

Parameters
[out]*infopointer to a ba234 info structure
Returns
status code
  • 0 success
  • 2 handle is NULL
Note
none

Definition at line 649 of file driver_ba234.c.

◆ ba234_init()

uint8_t ba234_init ( ba234_handle_t * handle)

initialize the chip

Parameters
[in]*handlepointer to a ba234 handle structure
Returns
status code
  • 0 success
  • 1 uart initialization failed
  • 2 handle is NULL
  • 3 linked functions is NULL
Note
none

Definition at line 188 of file driver_ba234.c.

◆ ba234_read()

uint8_t ba234_read ( ba234_handle_t * handle,
ba234_data_t * data )

read the data

Parameters
[in]*handlepointer to a ba234 handle structure
[out]*datapointer to a data structure address
Returns
status code
  • 0 success
  • 1 read failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 frame error
Note
none

Definition at line 291 of file driver_ba234.c.

◆ ba234_salinity_calibration()

uint8_t ba234_salinity_calibration ( ba234_handle_t * handle,
uint16_t value )

salinity calibration

Parameters
[in]*handlepointer to a ba234 handle structure
[in]valuesalinity calibration
Returns
status code
  • 0 success
  • 1 salinity calibration failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 frame error
  • 5 response error
Note
none

Definition at line 424 of file driver_ba234.c.

◆ ba234_salinity_convert_to_data()

uint8_t ba234_salinity_convert_to_data ( ba234_handle_t * handle,
uint16_t reg,
float * percentage )

convert the register raw data to the salinity

Parameters
[in]*handlepointer to a ba234 handle structure
[in]regregister raw data
[out]*percentagepointer to a percentage buffer
Returns
status code
  • 0 success
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 546 of file driver_ba234.c.

◆ ba234_salinity_convert_to_register()

uint8_t ba234_salinity_convert_to_register ( ba234_handle_t * handle,
float percentage,
uint16_t * reg )

convert the salinity to the register raw data

Parameters
[in]*handlepointer to a ba234 handle structure
[in]percentagesalinity percentage
[out]*regpointer to a register raw buffer
Returns
status code
  • 0 success
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 519 of file driver_ba234.c.