alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-02 01:41:12 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: Scrubbed ALL sensor library descriptions

Browse Source 
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>
This commit is contained in:
Noel Eck
2016-12-15 15:15:21 -08:00
parent 7a5c8a6cb3
commit 283fce619e
416 changed files with 793 additions and 675 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/wfs/CMakeLists.txt
View File

@ -1,7 +1,7 @@
upm_mixed_module_init (NAME wfs
DESCRIPTION "WFS (Water Flow Sensor)"
C_HDR wfs.h
C_SRC wfs.c
DESCRIPTION "WFS (Water Flow Sensor)"
CPP_HDR wfs.hpp
CPP_SRC wfs.cxx
CPP_WRAPS_C

142
src/wfs/wfs.hpp
View File

@ -27,109 +27,107 @@
namespace upm {
/**
* @brief Grove Water Flow Sensor library
* @defgroup wfs libupm-wfs
* @ingroup seeed gpio liquid eak
*/
/**
* @brief Grove Water Flow Sensor library
* @defgroup wfs libupm-wfs
* @ingroup seeed gpio liquid eak
*/
/**
* @library wfs
* @sensor wfs
* @comname Water Flow Sensor
* @altname Grove Water Flow Sensor
* @type liquid
* @man seeed
* @web http://www.seeedstudio.com/wiki/index.php?title=G1/2_Water_Flow_sensor
* @con gpio
* @kit eak
/**
* @library wfs
* @sensor wfs
* @comname Water Flow Sensor
* @altname Grove Water Flow Sensor
* @type liquid
* @man seeed
* @web http://wiki.seeedstudio.com/wiki/G1/2_Water_Flow_sensor
* @con gpio
* @kit eak
* @brief API for the Grove Water Flow Sensor
*
* This sensor is used to measure water flow in liters per
* minute (LPM). It incorporates a Hall Effect sensor. The UPM module
* defines an interrupt routine to be triggered on each low pulse,
* keeping count. This device requires a 10K pull-up resistor for
* the signal line (yellow wire). There is a schematic diagram on
* the SeeedStudio site (3/2015):
* http://www.seeedstudio.com/wiki/index.php?title=G1/2_Water_Flow_sensor
*
* However, be careful when wiring this up - the schematic appears to
* have a bug in it: the lower left connection of the signal line
* (yellow) to Vcc (red) should not be there. The sensor can work
* with this connection, but probably not for very long.
*
* @image html wfs.jpg
* @snippet wfs.cxx Interesting
*/
class WFS {
* @brief API for the Grove Water Flow Sensor
*
* This sensor is used to measure water flow in liters per
* minute (LPM). It incorporates a Hall Effect sensor. The UPM module
* defines an interrupt routine to be triggered on each low pulse,
* keeping count. This device requires a 10K pull-up resistor for
* the signal line (yellow wire). There is a schematic diagram on
* the SeeedStudio site (3/2015):
* http://www.seeedstudio.com/wiki/index.php?title=G1/2_Water_Flow_sensor
*
* However, be careful when wiring this up - the schematic appears to
* have a bug in it: the lower left connection of the signal line
* (yellow) to Vcc (red) should not be there. The sensor can work
* with this connection, but probably not for very long.
*
* @image html wfs.jpg
* @snippet wfs.cxx Interesting
*/
class WFS {
public:
/**
* Grove Water Flow sensor constructor
*
* @param pin GPIO pin to use. This must be an interrupt
* capable pin.
*/
* Grove Water Flow sensor constructor
*
* @param pin Digital pin to use
*/
WFS(int pin);
/**
* WFS destructor
*/
* WFS destructor
*/
~WFS();
/**
* Returns the number of milliseconds elapsed since initClock()
* was last called.
*
* @return Elapsed milliseconds
*/
* Returns the number of milliseconds elapsed since initClock()
* was last called.
*
* @return Elapsed milliseconds
*/
uint32_t getMillis();
/**
* Resets the clock
*
*/
* Resets the clock
*
*/
void initClock();
/**
* Resets the flow counter to 0. The flow counter should be
* stopped via stopFlowCounter() prior to calling this function.
*
*/
* Resets the flow counter to 0. The flow counter should be
* stopped via stopFlowCounter() prior to calling this function.
*
*/
void clearFlowCounter() { wfs_clear_flow_counter(m_wfs); };
/**
* Starts the flow counter
*
*/
* Starts the flow counter
*
*/
void startFlowCounter();
/**
* Stops the flow counter
*
*/
* Stops the flow counter
*
*/
void stopFlowCounter();
/**
* Gets the flow counter
*
* @return Flow counter
*/
* Gets the flow counter
*
* @return Flow counter
*/
uint32_t flowCounter() { return wfs_flow_counter(m_wfs); };
/**
* Computes the flow rate in liters per minute (LPM). Note, this
* is for the Grove WFS. If you are using some other WFS, you
* should compute the flow rate on your own based on the data for
* your sensor.
*
* @return Computed flow rate
*/
* Computes the flow rate in liters per minute (LPM). Note, this
* is for the Grove WFS. If you are using some other WFS, you
* should compute the flow rate on your own based on the data for
* your sensor.
*
* @return Computed flow rate
*/
float flowRate();
protected:
wfs_context m_wfs;
private:
};
};
}