LibDriver MLX90614
Loading...
Searching...
No Matches
mlx90614 basic driver function
mlx90614 driver function

mlx90614 basic driver modules More...

Collaboration diagram for mlx90614 basic driver function:

Data Structures

struct  mlx90614_handle_s
 mlx90614 handle structure definition More...
struct  mlx90614_info_s
 mlx90614 information structure definition More...

Typedefs

typedef struct mlx90614_handle_s mlx90614_handle_t
 mlx90614 handle structure definition
typedef struct mlx90614_info_s mlx90614_info_t
 mlx90614 information structure definition

Enumerations

enum  mlx90614_address_t { MLX90614_ADDRESS_DEFAULT = 0xB4 }
 mlx90614 address enumeration definition More...

Functions

uint8_t mlx90614_info (mlx90614_info_t *info)
 get chip information
uint8_t mlx90614_set_addr (mlx90614_handle_t *handle, uint8_t addr)
 set the address
uint8_t mlx90614_get_addr (mlx90614_handle_t *handle, uint8_t *addr)
 get the address
uint8_t mlx90614_init (mlx90614_handle_t *handle)
 initialize the chip
uint8_t mlx90614_deinit (mlx90614_handle_t *handle)
 close the chip
uint8_t mlx90614_read_object1 (mlx90614_handle_t *handle, uint16_t *raw, float *celsius)
 read the object1
uint8_t mlx90614_read_object2 (mlx90614_handle_t *handle, uint16_t *raw, float *celsius)
 read the object2
uint8_t mlx90614_read_raw_ir_channel (mlx90614_handle_t *handle, uint16_t *channel_1, uint16_t *channel_2)
 read the ir channel raw data
uint8_t mlx90614_read_ambient (mlx90614_handle_t *handle, uint16_t *raw, float *celsius)
 read the ambient

Detailed Description

mlx90614 basic driver modules

Typedef Documentation

◆ mlx90614_handle_t

typedef struct mlx90614_handle_s mlx90614_handle_t

mlx90614 handle structure definition

◆ mlx90614_info_t

typedef struct mlx90614_info_s mlx90614_info_t

mlx90614 information structure definition

Enumeration Type Documentation

◆ mlx90614_address_t

enum mlx90614_address_t

mlx90614 address enumeration definition

Enumerator
MLX90614_ADDRESS_DEFAULT 

default address

Definition at line 62 of file driver_mlx90614.h.

Function Documentation

◆ mlx90614_deinit()

uint8_t mlx90614_deinit ( mlx90614_handle_t * handle)

close the chip

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

Definition at line 1638 of file driver_mlx90614.c.

◆ mlx90614_get_addr()

uint8_t mlx90614_get_addr ( mlx90614_handle_t * handle,
uint8_t * addr )

get the address

Parameters
[in]*handlepointer to an mlx90614 handle structure
[out]*addrpointer to an iic address buffer
Returns
status code
  • 0 success
  • 2 handle is NULL
Note
none

Definition at line 266 of file driver_mlx90614.c.

◆ mlx90614_info()

uint8_t mlx90614_info ( mlx90614_info_t * info)

get chip information

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

Definition at line 1723 of file driver_mlx90614.c.

◆ mlx90614_init()

uint8_t mlx90614_init ( mlx90614_handle_t * handle)

initialize the chip

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

Definition at line 1564 of file driver_mlx90614.c.

◆ mlx90614_read_ambient()

uint8_t mlx90614_read_ambient ( mlx90614_handle_t * handle,
uint16_t * raw,
float * celsius )

read the ambient

Parameters
[in]*handlepointer to an mlx90614 handle structure
[out]*rawpointer to a raw data buffer
[out]*celsiuspointer to a celsius data buffer
Returns
status code
  • 0 success
  • 1 read ambient failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1215 of file driver_mlx90614.c.

◆ mlx90614_read_object1()

uint8_t mlx90614_read_object1 ( mlx90614_handle_t * handle,
uint16_t * raw,
float * celsius )

read the object1

Parameters
[in]*handlepointer to an mlx90614 handle structure
[out]*rawpointer to a raw data buffer
[out]*celsiuspointer to a celsius data buffer
Returns
status code
  • 0 success
  • 1 read object1 failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 flag error
Note
none

Definition at line 1253 of file driver_mlx90614.c.

◆ mlx90614_read_object2()

uint8_t mlx90614_read_object2 ( mlx90614_handle_t * handle,
uint16_t * raw,
float * celsius )

read the object2

Parameters
[in]*handlepointer to an mlx90614 handle structure
[out]*rawpointer to a raw data buffer
[out]*celsiuspointer to a celsius data buffer
Returns
status code
  • 0 success
  • 1 read object2 failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 flag error
Note
none

Definition at line 1297 of file driver_mlx90614.c.

◆ mlx90614_read_raw_ir_channel()

uint8_t mlx90614_read_raw_ir_channel ( mlx90614_handle_t * handle,
uint16_t * channel_1,
uint16_t * channel_2 )

read the ir channel raw data

Parameters
[in]*handlepointer to an mlx90614 handle structure
[out]*channel_1pointer to a channel 1 raw data buffer
[out]*channel_2pointer to a channel 2 raw data buffer
Returns
status code
  • 0 success
  • 1 read raw ir channel failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1172 of file driver_mlx90614.c.

◆ mlx90614_set_addr()

uint8_t mlx90614_set_addr ( mlx90614_handle_t * handle,
uint8_t addr )

set the address

Parameters
[in]*handlepointer to an mlx90614 handle structure
[in]addriic address
Returns
status code
  • 0 success
  • 2 handle is NULL
Note
none

Definition at line 245 of file driver_mlx90614.c.