saul.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015 Freie Universit├Ąt Berlin
3  *
4  * This file is subject to the terms and conditions of the GNU Lesser
5  * General Public License v2.1. See the file LICENSE in the top level
6  * directory for more details.
7  */
8 
48 #ifndef SAUL_H
49 #define SAUL_H
50 
51 #include <stdint.h>
52 #include <errno.h>
53 
54 #include "phydat.h"
55 
56 #ifdef __cplusplus
57 extern "C" {
58 #endif
59 
88 enum {
89  SAUL_CAT_UNDEF = 0x00,
90  SAUL_CAT_ACT = 0x40,
91  SAUL_CAT_SENSE = 0x80,
92 };
93 
97 enum {
105  /* Extend this list as needed, but keep SAUL_ACT_ID_ANY the first and
106  * SAUL_ACT_NUMOF the last entry
107  */
108 };
109 
113 enum {
144  /* Extend this list as needed, but keep SAUL_SENSE_ID_ANY the first and
145  * SAUL_SENSE_NUMOF the last entry
146  */
147 };
148 
155 enum {
227  SAUL_CLASS_ANY = 0xff
228  /* extend this list as needed... */
229 };
230 
235 enum {
236  SAUL_CAT_MASK = 0xc0,
237  SAUL_ID_MASK = 0x3f,
238 };
258 typedef int(*saul_read_t)(const void *dev, phydat_t *res);
259 
278 typedef int(*saul_write_t)(const void *dev, phydat_t *data);
279 
283 typedef struct {
286  uint8_t type;
287 } saul_driver_t;
288 
297 void saul_init_devs(void);
298 
302 int saul_notsup(const void *dev, phydat_t *dat);
303 
312 const char *saul_class_to_str(const uint8_t class_id);
313 
314 #ifdef __cplusplus
315 }
316 #endif
317 
318 #endif /* SAUL_H */
int(* saul_write_t)(const void *dev, phydat_t *data)
Write a value (a set of values) to a device.
Definition: saul.h:278
void saul_init_devs(void)
Initialize all available SAUL drivers.
int saul_notsup(const void *dev, phydat_t *dat)
Default not supported function.
const char * saul_class_to_str(const uint8_t class_id)
Helper function converts a class ID to a string.
int(* saul_read_t)(const void *dev, phydat_t *res)
Read a value (a set of values) from a device.
Definition: saul.h:258
@ SAUL_ID_MASK
Bitmask to obtain the intra-category ID.
Definition: saul.h:237
@ SAUL_CAT_MASK
Bitmask to obtain the category ID.
Definition: saul.h:236
@ SAUL_SENSE_CO2
sensor: CO2 Gas
Definition: saul.h:199
@ SAUL_ACT_MOTOR
actuator: motor
Definition: saul.h:163
@ SAUL_SENSE_GAS
sensor: Gas common
Definition: saul.h:203
@ SAUL_SENSE_ACCEL
sensor: accelerometer
Definition: saul.h:179
@ SAUL_SENSE_LIGHT
sensor: light
Definition: saul.h:177
@ SAUL_SENSE_ANALOG
sensor: raw analog value
Definition: saul.h:189
@ SAUL_SENSE_PH
sensor: pH
Definition: saul.h:221
@ SAUL_SENSE_CHARGE
sensor: coulomb counter
Definition: saul.h:211
@ SAUL_SENSE_RSSI
sensor: RSSI
Definition: saul.h:209
@ SAUL_SENSE_TEMP
sensor: temperature
Definition: saul.h:173
@ SAUL_SENSE_CURRENT
sensor: ammeter
Definition: saul.h:213
@ SAUL_SENSE_TVOC
sensor: TVOC Gas
Definition: saul.h:201
@ SAUL_ACT_ANY
any actuator - wildcard
Definition: saul.h:157
@ SAUL_SENSE_UV
sensor: UV index
Definition: saul.h:191
@ SAUL_SENSE_MAG
sensor: magnetometer
Definition: saul.h:181
@ SAUL_SENSE_DISTANCE
sensor: distance
Definition: saul.h:197
@ SAUL_SENSE_CAPACITANCE
sensor: capacitance
Definition: saul.h:217
@ SAUL_ACT_DIMMER
actuator: dimmable switch
Definition: saul.h:167
@ SAUL_ACT_LED_RGB
actuator: RGB LED
Definition: saul.h:159
@ SAUL_SENSE_OCCUP
sensor: occupancy
Definition: saul.h:205
@ SAUL_SENSE_HUM
sensor: humidity
Definition: saul.h:175
@ SAUL_ACT_SERVO
actuator: servo motor
Definition: saul.h:161
@ SAUL_SENSE_OBJTEMP
sensor: object temperature
Definition: saul.h:193
@ SAUL_CLASS_ANY
any device - wildcard
Definition: saul.h:227
@ SAUL_SENSE_BTN
sensor: simple button
Definition: saul.h:171
@ SAUL_SENSE_COUNT
sensor: pulse counter
Definition: saul.h:195
@ SAUL_SENSE_ANY
any sensor - wildcard
Definition: saul.h:169
@ SAUL_SENSE_GYRO
sensor: gyroscope
Definition: saul.h:183
@ SAUL_ACT_SWITCH
actuator: simple on/off switch
Definition: saul.h:165
@ SAUL_SENSE_VOLTAGE
sensor: voltage
Definition: saul.h:219
@ SAUL_SENSE_PROXIMITY
sensor: proximity
Definition: saul.h:207
@ SAUL_SENSE_COLOR
sensor: (light) color
Definition: saul.h:185
@ SAUL_SENSE_POWER
sensor: power
Definition: saul.h:223
@ SAUL_SENSE_PRESS
sensor: pressure
Definition: saul.h:187
@ SAUL_SENSE_SIZE
sensor: size
Definition: saul.h:225
@ SAUL_SENSE_PM
sensor: particulate matter
Definition: saul.h:215
@ SAUL_ACT_ID_SERVO
actuator: servo motor
Definition: saul.h:100
@ SAUL_ACT_ID_DIMMER
actuator: dimmable switch
Definition: saul.h:103
@ SAUL_ACT_ID_SWITCH
actuator: simple on/off switch
Definition: saul.h:102
@ SAUL_ACT_NUMOF
Number of actuators supported.
Definition: saul.h:104
@ SAUL_ACT_ID_ANY
any actuator - wildcard
Definition: saul.h:98
@ SAUL_ACT_ID_MOTOR
actuator: motor
Definition: saul.h:101
@ SAUL_ACT_ID_LED_RGB
actuator: RGB LED
Definition: saul.h:99
@ SAUL_CAT_SENSE
Sensor device class.
Definition: saul.h:91
@ SAUL_CAT_ACT
Actuator device class.
Definition: saul.h:90
@ SAUL_CAT_UNDEF
device class undefined
Definition: saul.h:89
@ SAUL_SENSE_ID_PH
sensor: pH
Definition: saul.h:140
@ SAUL_SENSE_ID_PROXIMITY
sensor: proximity
Definition: saul.h:133
@ SAUL_SENSE_ID_ANY
any sensor - wildcard
Definition: saul.h:114
@ SAUL_SENSE_ID_GAS
sensor: Gas common
Definition: saul.h:131
@ SAUL_SENSE_ID_OCCUP
sensor: occupancy
Definition: saul.h:132
@ SAUL_SENSE_ID_SIZE
sensor: size
Definition: saul.h:142
@ SAUL_SENSE_ID_UV
sensor: UV index
Definition: saul.h:125
@ SAUL_SENSE_ID_ACCEL
sensor: accelerometer
Definition: saul.h:119
@ SAUL_SENSE_ID_TEMP
sensor: temperature
Definition: saul.h:116
@ SAUL_SENSE_ID_TVOC
sensor: TVOC Gas
Definition: saul.h:130
@ SAUL_SENSE_ID_HUM
sensor: humidity
Definition: saul.h:117
@ SAUL_SENSE_ID_POWER
sensor: power
Definition: saul.h:141
@ SAUL_SENSE_ID_COLOR
sensor: (light) color
Definition: saul.h:122
@ SAUL_SENSE_ID_GYRO
sensor: gyroscope
Definition: saul.h:121
@ SAUL_SENSE_ID_VOLTAGE
sensor: voltage
Definition: saul.h:139
@ SAUL_SENSE_ID_OBJTEMP
sensor: object temperature
Definition: saul.h:126
@ SAUL_SENSE_ID_CURRENT
sensor: ammeter
Definition: saul.h:136
@ SAUL_SENSE_ID_PM
sensor: particulate matter
Definition: saul.h:137
@ SAUL_SENSE_ID_CHARGE
sensor: coulomb counter
Definition: saul.h:135
@ SAUL_SENSE_ID_CAPACITANCE
sensor: capacitance
Definition: saul.h:138
@ SAUL_SENSE_ID_MAG
sensor: magnetometer
Definition: saul.h:120
@ SAUL_SENSE_ID_CO2
sensor: CO2 Gas
Definition: saul.h:129
@ SAUL_SENSE_ID_DISTANCE
sensor: distance
Definition: saul.h:128
@ SAUL_SENSE_NUMOF
Number of actuators supported.
Definition: saul.h:143
@ SAUL_SENSE_ID_LIGHT
sensor: light
Definition: saul.h:118
@ SAUL_SENSE_ID_PRESS
sensor: pressure
Definition: saul.h:123
@ SAUL_SENSE_ID_COUNT
sensor: pulse counter
Definition: saul.h:127
@ SAUL_SENSE_ID_RSSI
sensor: RSSI
Definition: saul.h:134
@ SAUL_SENSE_ID_ANALOG
sensor: raw analog value
Definition: saul.h:124
@ SAUL_SENSE_ID_BTN
sensor: simple button
Definition: saul.h:115
Generic data container for physical data interface.
Generic data structure for expressing physical values.
Definition: phydat.h:150
Definition of the RIOT actuator/sensor interface.
Definition: saul.h:283
saul_write_t write
write function pointer
Definition: saul.h:285
uint8_t type
device class the device belongs to
Definition: saul.h:286
saul_read_t read
read function pointer
Definition: saul.h:284