Qubit 2020 / presensfirmwareupdate

Dependencies:   mbed

Embed: (wiki syntax)

« Back to documentation index

Show/hide line numbers light.h Source File

light.h

00001 #ifndef LIGHT_H
00002 #define LIGHT_H
00003 
00004 // Light intensity (0-100%)
00005 // 0% - light is off
00006 // 100% - light is on with max brightness
00007 #define LIGHT_MIN_INTENSITY 0
00008 #define LIGHT_MAX_INTENSITY 100
00009 #define LIGHT_OFF_INTENSITY LIGHT_MIN_INTENSITY
00010 
00011 /**
00012  * Initialize light.
00013  * Turns light off on the start of the board.
00014  */
00015 void lightInit(void);
00016 
00017 /**
00018  * Set light intensity.
00019  *
00020  * @param intensity Light intensity in percents.
00021  */
00022 void lightSet(unsigned char intensity);
00023 
00024 /**
00025  * Read light intensity.
00026  *
00027  * @return light intensity in percents.
00028  */
00029 unsigned char lightRead(void);
00030 
00031 /**
00032  * Check light.
00033  *
00034  * @return true if light is on, false - otherwise.
00035  */
00036 bool lightOn(void);
00037 
00038 #endif