ms5611 base driver modules More...

Collaboration diagram for ms5611 base driver function:

Data Structures
struct	ms5611_handle_s
	ms5611 handle structure definition More...
struct	ms5611_info_s
	ms5611 information structure definition More...

Typedefs
typedef struct ms5611_handle_s	ms5611_handle_t
	ms5611 handle structure definition
typedef struct ms5611_info_s	ms5611_info_t
	ms5611 information structure definition

Enumerations
enum	ms5611_interface_t { MS5611_INTERFACE_IIC = 0x00 , MS5611_INTERFACE_SPI = 0x01 }
	ms5611 interface enumeration definition More...
enum	ms5611_address_t { MS5611_ADDRESS_CSB_0 = 0xEE , MS5611_ADDRESS_CSB_1 = 0xEC }
	ms5611 address enumeration definition More...
enum	ms5611_bool_t { MS5611_BOOL_FALSE = 0x00 , MS5611_BOOL_TRUE = 0x01 }
	ms5611 bool enumeration definition More...
enum	ms5611_osr_t { MS5611_OSR_256 = 0x00 , MS5611_OSR_512 = 0x02 , MS5611_OSR_1024 = 0x04 , MS5611_OSR_2048 = 0x06 , MS5611_OSR_4096 = 0x08 }
	ms5611 osr enumeration definition More...

Functions
uint8_t	ms5611_info (ms5611_info_t *info)
	get chip's information
uint8_t	ms5611_set_interface (ms5611_handle_t *handle, ms5611_interface_t interface)
	set the chip interface
uint8_t	ms5611_get_interface (ms5611_handle_t handle, ms5611_interface_t interface)
	get the chip interface
uint8_t	ms5611_set_addr_pin (ms5611_handle_t *handle, ms5611_address_t addr_pin)
	set the iic address pin
uint8_t	ms5611_get_addr_pin (ms5611_handle_t handle, ms5611_address_t addr_pin)
	get the iic address pin
uint8_t	ms5611_set_temperature_osr (ms5611_handle_t *handle, ms5611_osr_t osr)
	set temperature osr
uint8_t	ms5611_get_temperature_osr (ms5611_handle_t handle, ms5611_osr_t osr)
	get temperature osr
uint8_t	ms5611_set_pressure_osr (ms5611_handle_t *handle, ms5611_osr_t osr)
	set pressure osr
uint8_t	ms5611_get_pressure_osr (ms5611_handle_t handle, ms5611_osr_t osr)
	get pressure osr
uint8_t	ms5611_init (ms5611_handle_t *handle)
	initialize the chip
uint8_t	ms5611_deinit (ms5611_handle_t *handle)
	close the chip
uint8_t	ms5611_read_temperature_pressure (ms5611_handle_t handle, uint32_t temperature_raw, float temperature_c, uint32_t pressure_raw, float *pressure_mbar)
	read the temperature and pressure
uint8_t	ms5611_read_temperature (ms5611_handle_t handle, uint32_t temperature_raw, float *temperature_c)
	read the temperature
uint8_t	ms5611_read_pressure (ms5611_handle_t handle, uint32_t pressure_raw, float *pressure_mbar)
	read the pressure
uint8_t	ms5611_reset (ms5611_handle_t *handle)
	reset the chip

Detailed Description

ms5611 base driver modules

Typedef Documentation

◆ ms5611_handle_t

typedef struct ms5611_handle_s ms5611_handle_t

ms5611 handle structure definition

◆ ms5611_info_t

typedef struct ms5611_info_s ms5611_info_t

ms5611 information structure definition

Enumeration Type Documentation

◆ ms5611_address_t

enum ms5611_address_t

ms5611 address enumeration definition

Enumerator
MS5611_ADDRESS_CSB_0	csb connected to the GND
MS5611_ADDRESS_CSB_1	csb connected to the VCC

Definition at line 71 of file driver_ms5611.h.

◆ ms5611_bool_t

enum ms5611_bool_t

ms5611 bool enumeration definition

Enumerator
MS5611_BOOL_FALSE	false
MS5611_BOOL_TRUE	true

Definition at line 80 of file driver_ms5611.h.

◆ ms5611_interface_t

enum ms5611_interface_t

ms5611 interface enumeration definition

Enumerator
MS5611_INTERFACE_IIC	iic interface function
MS5611_INTERFACE_SPI	spi interface function

Definition at line 62 of file driver_ms5611.h.

◆ ms5611_osr_t

enum ms5611_osr_t

ms5611 osr enumeration definition

Enumerator
MS5611_OSR_256	256
MS5611_OSR_512	512
MS5611_OSR_1024	1024
MS5611_OSR_2048	2048
MS5611_OSR_4096	4096

Definition at line 89 of file driver_ms5611.h.

Function Documentation

◆ ms5611_deinit()

uint8_t ms5611_deinit ( ms5611_handle_t * handle )

close the chip

Parameters

[in] *handle pointer to an ms5611 handle structure

Returns

status code

0 success
1 iic or spi deinit failed
2 handle is NULL
3 handle is not initialized
4 reset failed

Note: none

Definition at line 959 of file driver_ms5611.c.

◆ ms5611_get_addr_pin()

uint8_t ms5611_get_addr_pin	(	ms5611_handle_t *	handle,
		ms5611_address_t *	addr_pin )

get the iic address pin

Parameters

[in]	*handle	pointer to an ms5611 handle structure
[out]	*addr_pin	pointer to an address pin buffer

Returns

status code

0 success
2 handle is NULL

Note: none

Definition at line 294 of file driver_ms5611.c.

◆ ms5611_get_interface()

uint8_t ms5611_get_interface	(	ms5611_handle_t *	handle,
		ms5611_interface_t *	interface )

get the chip interface

Parameters

[in]	*handle	pointer to an ms5611 handle structure
[out]	*interface	pointer to a chip interface buffer

Returns

status code

0 success
2 handle is NULL

Note: none

Definition at line 252 of file driver_ms5611.c.

◆ ms5611_get_pressure_osr()

uint8_t ms5611_get_pressure_osr	(	ms5611_handle_t *	handle,
		ms5611_osr_t *	osr )

get pressure osr

Parameters

[in]	*handle	pointer to an ms5611 handle structure
[out]	*osr	pointer to an osr buffer

Returns

status code

0 success
2 handle is NULL

Note: none

Definition at line 378 of file driver_ms5611.c.

◆ ms5611_get_temperature_osr()

uint8_t ms5611_get_temperature_osr	(	ms5611_handle_t *	handle,
		ms5611_osr_t *	osr )

get temperature osr

Parameters

[in]	*handle	pointer to an ms5611 handle structure
[out]	*osr	pointer to an osr buffer

Returns

status code

0 success
2 handle is NULL

Note: none

Definition at line 336 of file driver_ms5611.c.

◆ ms5611_info()

uint8_t ms5611_info ( ms5611_info_t * info )

get chip's information

Parameters

[out] *info pointer to an ms5611 info structure

Returns

status code

0 success
2 handle is NULL

Note: none

Definition at line 1055 of file driver_ms5611.c.

◆ ms5611_init()

uint8_t ms5611_init ( ms5611_handle_t * handle )

initialize the chip

Parameters

[in] *handle pointer to an ms5611 handle structure

Returns

status code

0 success
1 spi or iic initialization failed
2 handle is NULL
3 linked functions is NULL
4 reset failed
5 prom read failed

Note: none

Definition at line 842 of file driver_ms5611.c.

◆ ms5611_read_pressure()

uint8_t ms5611_read_pressure	(	ms5611_handle_t *	handle,
		uint32_t *	pressure_raw,
		float *	pressure_mbar )

read the pressure

Parameters

[in]	*handle	pointer to an ms5611 handle structure
[out]	*pressure_raw	pointer to a raw pressure buffer
[out]	*pressure_mbar	pointer to a converted pressure buffer

Returns

status code

0 success
1 read pressure failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 665 of file driver_ms5611.c.

◆ ms5611_read_temperature()

uint8_t ms5611_read_temperature	(	ms5611_handle_t *	handle,
		uint32_t *	temperature_raw,
		float *	temperature_c )

read the temperature

Parameters

[in]	*handle	pointer to an ms5611 handle structure
[out]	*temperature_raw	pointer to a raw temperature buffer
[out]	*temperature_c	pointer to a converted temperature buffer

Returns

status code

0 success
1 read temperature failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 582 of file driver_ms5611.c.

◆ ms5611_read_temperature_pressure()

uint8_t ms5611_read_temperature_pressure	(	ms5611_handle_t *	handle,
		uint32_t *	temperature_raw,
		float *	temperature_c,
		uint32_t *	pressure_raw,
		float *	pressure_mbar )

read the temperature and pressure

Parameters

[in]	*handle	pointer to an ms5611 handle structure
[out]	*temperature_raw	pointer to a raw temperature buffer
[out]	*temperature_c	pointer to a converted temperature buffer
[out]	*pressure_raw	pointer to a raw pressure buffer
[out]	*pressure_mbar	pointer to a converted pressure buffer

Returns

status code

0 success
1 read temperature pressure failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 439 of file driver_ms5611.c.

◆ ms5611_reset()

uint8_t ms5611_reset ( ms5611_handle_t * handle )

reset the chip

Parameters

[in] *handle pointer to an ms5611 handle structure

Returns

status code

0 success
1 reset failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 400 of file driver_ms5611.c.

◆ ms5611_set_addr_pin()

uint8_t ms5611_set_addr_pin	(	ms5611_handle_t *	handle,
		ms5611_address_t	addr_pin )

set the iic address pin

Parameters

[in]	*handle	pointer to an ms5611 handle structure
[in]	addr_pin	address pin

Returns

status code

0 success
2 handle is NULL

Note: none

Definition at line 273 of file driver_ms5611.c.

◆ ms5611_set_interface()

uint8_t ms5611_set_interface	(	ms5611_handle_t *	handle,
		ms5611_interface_t	interface )

set the chip interface

Parameters

[in]	*handle	pointer to an ms5611 handle structure
[in]	interface	chip interface

Returns

status code

0 success
2 handle is NULL

Note: none

Definition at line 231 of file driver_ms5611.c.

◆ ms5611_set_pressure_osr()

uint8_t ms5611_set_pressure_osr	(	ms5611_handle_t *	handle,
		ms5611_osr_t	osr )

set pressure osr

Parameters

[in]	*handle	pointer to an ms5611 handle structure
[in]	osr	set osr

Returns

status code

0 success
2 handle is NULL

Note: none

Definition at line 357 of file driver_ms5611.c.

◆ ms5611_set_temperature_osr()

uint8_t ms5611_set_temperature_osr	(	ms5611_handle_t *	handle,
		ms5611_osr_t	osr )

set temperature osr

Parameters

[in]	*handle	pointer to an ms5611 handle structure
[in]	osr	set osr

Returns

status code

0 success
2 handle is NULL

Note: none

Definition at line 315 of file driver_ms5611.c.

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ ms5611_handle_t

◆ ms5611_info_t

Enumeration Type Documentation

◆ ms5611_address_t

◆ ms5611_bool_t

◆ ms5611_interface_t

◆ ms5611_osr_t

Function Documentation

◆ ms5611_deinit()

◆ ms5611_get_addr_pin()

◆ ms5611_get_interface()

◆ ms5611_get_pressure_osr()

◆ ms5611_get_temperature_osr()

◆ ms5611_info()

◆ ms5611_init()

◆ ms5611_read_pressure()

◆ ms5611_read_temperature()

◆ ms5611_read_temperature_pressure()

◆ ms5611_reset()

◆ ms5611_set_addr_pin()

◆ ms5611_set_interface()

◆ ms5611_set_pressure_osr()

◆ ms5611_set_temperature_osr()