mirror of
https://github.com/eclipse/upm.git
synced 2025-03-26 02:10:02 +03:00
283fce619e
In an effort to clean-up and standardize UPM library
documentation, this commit updates (and in most cases,
unifies) the CMake description string AND CXX header
@comname string.
Strings were taken from datasheets when possible, spelling
mistakes were addressed, copy/paste errors where fixed,
Title Case was used, etc.
* Tested/updated/added @web tags
* Added/updated invalid sensor images
* Added/updated @man tags, added missing manufacturers
Signed-off-by: Noel Eck <noel.eck@intel.com>
81 lines
2.3 KiB
C++
81 lines
2.3 KiB
C++
/*
|
|
* Author: Henry Bruce <henry.bruce@intel.com>
|
|
* Copyright (c) 2014 Intel Corporation.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining
|
|
* a copy of this software and associated documentation files (the
|
|
* "Software"), to deal in the Software without restriction, including
|
|
* without limitation the rights to use, copy, modify, merge, publish,
|
|
* distribute, sublicense, and/or sell copies of the Software, and to
|
|
* permit persons to whom the Software is furnished to do so, subject to
|
|
* the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be
|
|
* included in all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
|
|
#include "iLightController.hpp"
|
|
#include "mraa/i2c.hpp"
|
|
|
|
namespace upm
|
|
{
|
|
/**
|
|
* @brief DS1808LC lighting controller library
|
|
* @defgroup DS1808LC libupm-ds1808lc
|
|
* @ingroup ds1808lc i2c maxim light ilightcontroller
|
|
*/
|
|
|
|
/**
|
|
* @brief API for DS1808 Dual Log Digital Potentiometer as a Light Controller
|
|
*
|
|
* The Maxim Integrated
|
|
* [DS1808](http://www.maximintegrated.com/en/products/analog/data-converters/digital-potentiometers/DS1808.html)
|
|
* Dual Log Digital Potentiometer
|
|
*
|
|
*
|
|
* @library ds1808lc
|
|
* @sensor ds1808lc
|
|
* @comname Lighting Controller
|
|
* @altname DS1808LC
|
|
* @type light
|
|
* @man maxim
|
|
* @con i2c
|
|
* @if ilightcontroller
|
|
*/
|
|
class DS1808LC : public upm::ILightController
|
|
{
|
|
public:
|
|
DS1808LC(int gpioPower, int i2cBus);
|
|
~DS1808LC();
|
|
|
|
protected:
|
|
const char* getModuleName() { return "ds1808lc"; }
|
|
bool isPowered();
|
|
void setPowerOn();
|
|
void setPowerOff();
|
|
int getBrightness();
|
|
void setBrightness(int dutyPercent);
|
|
|
|
private:
|
|
int getPercentBrightness(uint8_t val1, uint8_t val2);
|
|
uint8_t getPot1Value(int dutyPercent);
|
|
uint8_t getPot2Value(int dutyPercent);
|
|
int getScaledResistance(int dutyPercent);
|
|
|
|
mraa::Result status;
|
|
mraa::I2c* i2c;
|
|
int pinPower;
|
|
};
|
|
|
|
|
|
}
|
|
|