speedsense 2.1.0.0
speedsense.h File Reference

This file contains API for Speed Sense Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"

Go to the source code of this file.

Data Structures

struct  speedsense_t
 Speed Sense Click context object. More...
 
struct  speedsense_cfg_t
 Speed Sense Click configuration object. More...
 

Macros

#define SPEEDSENSE_CNV_MIN_TO_MS   60000.0f
 Speed Sense conversion of minutes to milliseconds data value.
 
#define SPEEDSENSE_DIR_STATE_FWD   0
 Speed Sense output signal states data value.
 
#define SPEEDSENSE_DIR_STATE_RVS   1
 
#define SPEEDSENSE_SPEED_STATE_LOW   0
 
#define SPEEDSENSE_SPEED_STATE_HIGH   1
 
#define SPEEDSENSE_STOP_MEASURE   0
 Speed Sense measurement state data values.
 
#define SPEEDSENSE_START_NEW_MEASURE   1
 
#define SPEEDSENSE_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  speedsense_return_value_t { SPEEDSENSE_OK = 0 , SPEEDSENSE_ERROR = -1 }
 Speed Sense Click return value data. More...
 

Functions

void speedsense_cfg_setup (speedsense_cfg_t *cfg)
 Speed Sense configuration object setup function.
 
err_t speedsense_init (speedsense_t *ctx, speedsense_cfg_t *cfg)
 Speed Sense initialization function.
 
uint8_t speedsense_get_speed (speedsense_t *ctx)
 Speed Sense CHA pin reading function.
 
uint8_t speedsense_get_direction (speedsense_t *ctx)
 Speed Sense CHB pin reading function.
 

Detailed Description

This file contains API for Speed Sense Click Driver.

Enumeration Type Documentation

◆ speedsense_return_value_t

Speed Sense Click return value data.

Predefined enum values for driver return values.

Enumerator
SPEEDSENSE_OK 
SPEEDSENSE_ERROR