ISSDK  1.8
IoT Sensing Software Development Kit
Data Structures | Macros | Typedefs | Enumerations
sensor_drv.h File Reference

The sensor_drv.h file contains sensor state and error definitions. More...

#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
Include dependency graph for sensor_drv.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  registerwritelist_t
 This structure defines the Write command List. More...
 
struct  registerreadlist_t
 This structure defines the Read command List. More...
 
struct  registercommandlist_t
 This structure defines the Block command List. More...
 
struct  registerDeviceInfo_t
 This structure defines the device specific info required by register I/O. More...
 

Macros

#define SENSOR_MAX_REGISTER_COUNT   128 /* As per 7-Bit address. */
 
#define __END_WRITE_DATA__
 
#define __END_READ_DATA__
 
#define __END_WRITE_CMD__
 

Typedefs

typedef enum EWriteFlags EWriteFlags_t
 
typedef void(* registeridlefunction_t) (void *userParam)
 This is the register idle function type. More...
 

Enumerations

enum  EWriteFlags { WRITE_OVERWRITE = 0, WRITE_MASK = 1 }
 
enum  ESensorErrors {
  SENSOR_ERROR_NONE = 0, SENSOR_ERROR_INVALID_PARAM, SENSOR_ERROR_BAD_ADDRESS, SENSOR_ERROR_INIT,
  SENSOR_ERROR_WRITE, SENSOR_ERROR_READ
}
 

Detailed Description

The sensor_drv.h file contains sensor state and error definitions.

Definition in file sensor_drv.h.

Macro Definition Documentation

◆ __END_READ_DATA__

#define __END_READ_DATA__
Value:
{ \
.readFrom = 0xFFFF, .numBytes = 0 \
}

Definition at line 51 of file sensor_drv.h.

Referenced by apply_register_read(), and apply_register_readall().

◆ __END_WRITE_CMD__

#define __END_WRITE_CMD__
Value:
{ \
.writeTo = 0xFFFF, .numBytes = 0 \
}

Definition at line 57 of file sensor_drv.h.

Referenced by FXLC95000_I2C_FlashPayload().

◆ __END_WRITE_DATA__

#define __END_WRITE_DATA__
Value:
{ \
.writeTo = 0xFFFF, .value = 0 \
}

Definition at line 45 of file sensor_drv.h.

Referenced by apply_register_write().

◆ SENSOR_MAX_REGISTER_COUNT

#define SENSOR_MAX_REGISTER_COUNT   128 /* As per 7-Bit address. */

Definition at line 42 of file sensor_drv.h.

Referenced by Register_I2C_BlockWrite().

Typedef Documentation

◆ EWriteFlags_t

typedef enum EWriteFlags EWriteFlags_t

◆ registeridlefunction_t

typedef void(* registeridlefunction_t) (void *userParam)

This is the register idle function type.

Definition at line 97 of file sensor_drv.h.

Enumeration Type Documentation

◆ ESensorErrors

Enumerator
SENSOR_ERROR_NONE 
SENSOR_ERROR_INVALID_PARAM 
SENSOR_ERROR_BAD_ADDRESS 
SENSOR_ERROR_INIT 
SENSOR_ERROR_WRITE 
SENSOR_ERROR_READ 

Definition at line 31 of file sensor_drv.h.

◆ EWriteFlags

Enumerator
WRITE_OVERWRITE 
WRITE_MASK 

Definition at line 24 of file sensor_drv.h.