driver pmw3901mb header file More...

#include <stdio.h>
#include <stdint.h>
#include <string.h>

Include dependency graph for driver_pmw3901mb.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	pmw3901mb_motion_s
	pmw3901mb motion structure definition More...
struct	pmw3901mb_handle_s
	pmw3901mb handle structure definition More...
struct	pmw3901mb_info_s
	pmw3901mb information structure definition More...

Macros
#define	DRIVER_PMW3901MB_LINK_INIT(HANDLE, STRUCTURE)
	initialize pmw3901mb_handle_t structure
#define	DRIVER_PMW3901MB_LINK_SPI_INIT(HANDLE, FUC)
	link spi_init function
#define	DRIVER_PMW3901MB_LINK_SPI_DEINIT(HANDLE, FUC)
	link spi_deinit function
#define	DRIVER_PMW3901MB_LINK_SPI_READ(HANDLE, FUC)
	link spi_read function
#define	DRIVER_PMW3901MB_LINK_SPI_WRITE(HANDLE, FUC)
	link spi_write function
#define	DRIVER_PMW3901MB_LINK_RESET_GPIO_INIT(HANDLE, FUC)
	link reset_gpio_init function
#define	DRIVER_PMW3901MB_LINK_RESET_GPIO_DEINIT(HANDLE, FUC)
	link reset_gpio_deinit function
#define	DRIVER_PMW3901MB_LINK_RESET_GPIO_WRITE(HANDLE, FUC)
	link reset_gpio_write function
#define	DRIVER_PMW3901MB_LINK_DELAY_MS(HANDLE, FUC)
	link delay_ms function
#define	DRIVER_PMW3901MB_LINK_DEBUG_PRINT(HANDLE, FUC)
	link debug_print function

Typedefs
typedef struct pmw3901mb_motion_s	pmw3901mb_motion_t
	pmw3901mb motion structure definition
typedef struct pmw3901mb_handle_s	pmw3901mb_handle_t
	pmw3901mb handle structure definition
typedef struct pmw3901mb_info_s	pmw3901mb_info_t
	pmw3901mb information structure definition

Functions
uint8_t	pmw3901mb_info (pmw3901mb_info_t *info)
	get chip's information
uint8_t	pmw3901mb_init (pmw3901mb_handle_t *handle)
	initialize the chip
uint8_t	pmw3901mb_deinit (pmw3901mb_handle_t *handle)
	close the chip
uint8_t	pmw3901mb_power_up (pmw3901mb_handle_t *handle)
	power up the chip
uint8_t	pmw3901mb_shutdown (pmw3901mb_handle_t *handle)
	shutdown the chip
uint8_t	pmw3901mb_reset (pmw3901mb_handle_t *handle)
	reset the chip
uint8_t	pmw3901mb_set_optimum_performance (pmw3901mb_handle_t *handle)
	set the optimum performance
uint8_t	pmw3901mb_burst_read (pmw3901mb_handle_t handle, pmw3901mb_motion_t motion)
	burst read data
uint8_t	pmw3901mb_delta_raw_to_delta_cm (pmw3901mb_handle_t handle, int16_t raw, float height_m, float cm)
	convert the delta raw to the delta cm
uint8_t	pmw3901mb_start_frame_capture (pmw3901mb_handle_t *handle)
	start frame capture
uint8_t	pmw3901mb_stop_frame_capture (pmw3901mb_handle_t *handle)
	stop frame capture
uint8_t	pmw3901mb_get_frame (pmw3901mb_handle_t *handle, uint8_t frame[35][35])
	get the frame
uint8_t	pmw3901mb_get_product_id (pmw3901mb_handle_t handle, uint8_t id)
	get the product id
uint8_t	pmw3901mb_get_inverse_product_id (pmw3901mb_handle_t handle, uint8_t id)
	get the inverse product id
uint8_t	pmw3901mb_get_revision_id (pmw3901mb_handle_t handle, uint8_t id)
	get the revision id
uint8_t	pmw3901mb_get_motion (pmw3901mb_handle_t handle, uint8_t motion)
	get the motion
uint8_t	pmw3901mb_set_motion (pmw3901mb_handle_t *handle, uint8_t motion)
	set the motion
uint8_t	pmw3901mb_get_delta_x (pmw3901mb_handle_t handle, int16_t delta)
	get the delta x
uint8_t	pmw3901mb_get_delta_y (pmw3901mb_handle_t handle, int16_t delta)
	get the delta y
uint8_t	pmw3901mb_get_motion_burst (pmw3901mb_handle_t handle, uint8_t burst, uint8_t len)
	get the motion burst
uint8_t	pmw3901mb_get_squal (pmw3901mb_handle_t handle, uint8_t squal)
	get the surface quality
uint8_t	pmw3901mb_get_raw_data_sum (pmw3901mb_handle_t handle, uint8_t sum)
	get the average raw data value
uint8_t	pmw3901mb_get_max_raw_data (pmw3901mb_handle_t handle, uint8_t max)
	get the maximum raw data value
uint8_t	pmw3901mb_get_min_raw_data (pmw3901mb_handle_t handle, uint8_t min)
	get the minimum raw data value
uint8_t	pmw3901mb_get_shutter (pmw3901mb_handle_t handle, uint16_t shutter)
	get the shutter
uint8_t	pmw3901mb_get_observation (pmw3901mb_handle_t handle, uint8_t observation)
	get the observation
uint8_t	pmw3901mb_set_observation (pmw3901mb_handle_t *handle, uint8_t observation)
	set the observation
uint8_t	pmw3901mb_get_raw_data_grab (pmw3901mb_handle_t handle, uint8_t grab, uint16_t len)
	get the raw data grab
uint8_t	pmw3901mb_set_raw_data_grab (pmw3901mb_handle_t handle, uint8_t grab, uint16_t len)
	set the raw data grab
uint8_t	pmw3901mb_get_raw_data_grab_status (pmw3901mb_handle_t handle, uint8_t status)
	get the raw data grab status
uint8_t	pmw3901mb_set_reg (pmw3901mb_handle_t handle, uint8_t reg, uint8_t buf, uint16_t len)
	set the chip register
uint8_t	pmw3901mb_get_reg (pmw3901mb_handle_t handle, uint8_t reg, uint8_t buf, uint16_t len)
	get the chip register

Detailed Description

driver pmw3901mb header file

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Version: 1.0.0

Author: Shifeng Li

Date: 2022-01-08

history

Date	Version	Author	Description
2022/01/08	1.0	Shifeng Li	first upload

Definition in file driver_pmw3901mb.h.

Data Structures

Macros

Typedefs

Functions

Detailed Description

history