saul.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2015 Freie Universität Berlin
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <errno.h>
#include <stdint.h>
#include <sys/types.h>
 
#include "phydat.h"
 
#ifdef __cplusplus
extern "C" {
#endif

enum {
    SAUL_CAT_UNDEF        = 0x00,   
    SAUL_CAT_ACT          = 0x40,   
    SAUL_CAT_SENSE        = 0x80,   
};

enum {
    SAUL_ACT_ID_ANY,                  
    SAUL_ACT_ID_LED_RGB,              
    SAUL_ACT_ID_SERVO,                
    SAUL_ACT_ID_MOTOR,                
    SAUL_ACT_ID_SWITCH,               
    SAUL_ACT_ID_DIMMER,               
    SAUL_ACT_ID_VOLTAGE,              
    SAUL_ACT_ID_CURRENT,              
    SAUL_ACT_NUMOF                    
    /* Extend this list as needed, but keep SAUL_ACT_ID_ANY the first and
     * SAUL_ACT_NUMOF the last entry
     */
};

enum {
    SAUL_SENSE_ID_ANY,              
    SAUL_SENSE_ID_BTN,              
    SAUL_SENSE_ID_TEMP,             
    SAUL_SENSE_ID_HUM,              
    SAUL_SENSE_ID_LIGHT,            
    SAUL_SENSE_ID_ACCEL,            
    SAUL_SENSE_ID_MAG,              
    SAUL_SENSE_ID_GYRO,             
    SAUL_SENSE_ID_COLOR,            
    SAUL_SENSE_ID_PRESS,            
    SAUL_SENSE_ID_ANALOG,           
    SAUL_SENSE_ID_UV,               
    SAUL_SENSE_ID_OBJTEMP,          
    SAUL_SENSE_ID_COUNT,            
    SAUL_SENSE_ID_DISTANCE,         
    SAUL_SENSE_ID_CO2,              
    SAUL_SENSE_ID_TVOC,             
    SAUL_SENSE_ID_GAS,              
    SAUL_SENSE_ID_OCCUP,            
    SAUL_SENSE_ID_PROXIMITY,        
    SAUL_SENSE_ID_RSSI,             
    SAUL_SENSE_ID_CHARGE,           
    SAUL_SENSE_ID_CURRENT,          
    SAUL_SENSE_ID_PM,               
    SAUL_SENSE_ID_CAPACITANCE,      
    SAUL_SENSE_ID_VOLTAGE,          
    SAUL_SENSE_ID_PH,               
    SAUL_SENSE_ID_POWER,            
    SAUL_SENSE_ID_SIZE,             
    SAUL_SENSE_NUMOF                
    /* Extend this list as needed, but keep SAUL_SENSE_ID_ANY the first and
     * SAUL_SENSE_NUMOF the last entry
     */
};

enum {
    SAUL_ACT_ANY            = SAUL_CAT_ACT | SAUL_ACT_ID_ANY,
    SAUL_ACT_LED_RGB        = SAUL_CAT_ACT | SAUL_ACT_ID_LED_RGB,
    SAUL_ACT_SERVO          = SAUL_CAT_ACT | SAUL_ACT_ID_SERVO,
    SAUL_ACT_MOTOR          = SAUL_CAT_ACT | SAUL_ACT_ID_MOTOR,
    SAUL_ACT_SWITCH         = SAUL_CAT_ACT | SAUL_ACT_ID_SWITCH,
    SAUL_ACT_DIMMER         = SAUL_CAT_ACT | SAUL_ACT_ID_DIMMER,
    SAUL_ACT_CURRENT        = SAUL_CAT_ACT | SAUL_ACT_ID_CURRENT,
    SAUL_ACT_VOLTAGE        = SAUL_CAT_ACT | SAUL_ACT_ID_VOLTAGE,
    SAUL_SENSE_ANY          = SAUL_CAT_SENSE | SAUL_SENSE_ID_ANY,
    SAUL_SENSE_BTN          = SAUL_CAT_SENSE | SAUL_SENSE_ID_BTN,
    SAUL_SENSE_TEMP         = SAUL_CAT_SENSE | SAUL_SENSE_ID_TEMP,
    SAUL_SENSE_HUM          = SAUL_CAT_SENSE | SAUL_SENSE_ID_HUM,
    SAUL_SENSE_LIGHT        = SAUL_CAT_SENSE | SAUL_SENSE_ID_LIGHT,
    SAUL_SENSE_ACCEL        = SAUL_CAT_SENSE | SAUL_SENSE_ID_ACCEL,
    SAUL_SENSE_MAG          = SAUL_CAT_SENSE | SAUL_SENSE_ID_MAG,
    SAUL_SENSE_GYRO         = SAUL_CAT_SENSE | SAUL_SENSE_ID_GYRO,
    SAUL_SENSE_COLOR        = SAUL_CAT_SENSE | SAUL_SENSE_ID_COLOR,
    SAUL_SENSE_PRESS        = SAUL_CAT_SENSE | SAUL_SENSE_ID_PRESS,
    SAUL_SENSE_ANALOG       = SAUL_CAT_SENSE | SAUL_SENSE_ID_ANALOG,
    SAUL_SENSE_UV           = SAUL_CAT_SENSE | SAUL_SENSE_ID_UV,
    SAUL_SENSE_OBJTEMP      = SAUL_CAT_SENSE | SAUL_SENSE_ID_OBJTEMP,
    SAUL_SENSE_COUNT        = SAUL_CAT_SENSE | SAUL_SENSE_ID_COUNT,
    SAUL_SENSE_DISTANCE     = SAUL_CAT_SENSE | SAUL_SENSE_ID_DISTANCE,
    SAUL_SENSE_CO2          = SAUL_CAT_SENSE | SAUL_SENSE_ID_CO2,
    SAUL_SENSE_TVOC         = SAUL_CAT_SENSE | SAUL_SENSE_ID_TVOC,
    SAUL_SENSE_GAS          = SAUL_CAT_SENSE | SAUL_SENSE_ID_GAS,
    SAUL_SENSE_OCCUP        = SAUL_CAT_SENSE | SAUL_SENSE_ID_OCCUP,
    SAUL_SENSE_PROXIMITY    = SAUL_CAT_SENSE | SAUL_SENSE_ID_PROXIMITY,
    SAUL_SENSE_RSSI         = SAUL_CAT_SENSE | SAUL_SENSE_ID_RSSI,
    SAUL_SENSE_CHARGE       = SAUL_CAT_SENSE | SAUL_SENSE_ID_CHARGE,
    SAUL_SENSE_CURRENT      = SAUL_CAT_SENSE | SAUL_SENSE_ID_CURRENT,
    SAUL_SENSE_PM           = SAUL_CAT_SENSE | SAUL_SENSE_ID_PM,
    SAUL_SENSE_CAPACITANCE  = SAUL_CAT_SENSE | SAUL_SENSE_ID_CAPACITANCE,
    SAUL_SENSE_VOLTAGE      = SAUL_CAT_SENSE | SAUL_SENSE_ID_VOLTAGE,
    SAUL_SENSE_PH           = SAUL_CAT_SENSE | SAUL_SENSE_ID_PH,
    SAUL_SENSE_POWER        = SAUL_CAT_SENSE | SAUL_SENSE_ID_POWER,
    SAUL_SENSE_SIZE         = SAUL_CAT_SENSE | SAUL_SENSE_ID_SIZE,
    SAUL_CLASS_ANY          = 0xff
    /* extend this list as needed... */
};

enum {
    SAUL_CAT_MASK           = 0xc0, 
    SAUL_ID_MASK            = 0x3f, 
};

typedef int(*saul_read_t)(const void *dev, phydat_t *res);

typedef int(*saul_write_t)(const void *dev, const phydat_t *data);

typedef struct {
    saul_read_t read;       
    saul_write_t write;     
    uint8_t type;           
} saul_driver_t;

void saul_init_devs(void);

int saul_write_notsup(const void *dev, const phydat_t *dat);

int saul_read_notsup(const void *dev, phydat_t *dat);

const char *saul_class_to_str(const uint8_t class_id);

void saul_class_print(uint8_t class_id);

ssize_t saul_class_write(char *dest, size_t max_size, uint8_t class_id);
 
#ifdef __cplusplus
}
#endif