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

wfs: C port; C++ wraps C

Browse Source 
Signed-off-by: Jon Trulson <jtrulson@ics.com>
This commit is contained in:
Jon Trulson
2017-01-26 15:06:05 -07:00
parent 0a91eb0b46
commit 849711c47d
11 changed files with 537 additions and 208 deletions
Download Patch File Download Diff File Expand all files Collapse all files

196
src/wfs/wfs.hpp
View File

@ -1,6 +1,6 @@
/*
* Author: Jon Trulson <jtrulson@ics.com>
* Copyright (c) 2015 Intel Corporation.
* Copyright (c) 2015-2017 Intel Corporation.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
@ -23,119 +23,113 @@
*/
#pragma once
#include <string>
#include <stdint.h>
#include <sys/time.h>
#include <mraa/gpio.h>
#include "wfs.h"
namespace upm {
/**
* @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
* @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
* @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
* @brief API for the Grove Water Flow Sensor
*
* @param pin Digital pin to use
*/
WFS(int pin);
/**
* WFS destructor
*/
~WFS();
/**
* Returns the number of milliseconds elapsed since initClock()
* was last called.
* 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
*
* @return Elapsed milliseconds
*/
uint32_t getMillis();
/**
* Resets the clock
* 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
*/
void initClock();
class WFS {
public:
/**
* Grove Water Flow sensor constructor
*
* @param pin GPIO pin to use. This must be an interrupt
* capable pin.
*/
WFS(int pin);
/**
* Resets the flow counter to 0. The flow counter should be
* stopped via stopFlowCounter() prior to calling this function.
*
*/
void clearFlowCounter() { m_flowCounter = 0; };
/**
* WFS destructor
*/
~WFS();
/**
* Starts the flow counter
*
*/
void startFlowCounter();
/**
* Returns the number of milliseconds elapsed since initClock()
* was last called.
*
* @return Elapsed milliseconds
*/
uint32_t getMillis();
/**
* Stops the flow counter
*
*/
void stopFlowCounter();
/**
* Resets the clock
*
*/
void initClock();
/**
* Gets the flow counter
*
* @return Flow counter
*/
uint32_t flowCounter() { return m_flowCounter; };
/**
* 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); };
/**
* Computes the flow rate in liters per minute (LPM)
*
* @return Computed flow rate
*/
float flowRate();
/**
* Starts the flow counter
*
*/
void startFlowCounter();
private:
/**
* Flow interrupt service routine (ISR)
*
*/
static void flowISR(void *ctx);
/**
* Stops the flow counter
*
*/
void stopFlowCounter();
volatile uint32_t m_flowCounter;
struct timeval m_startTime;
mraa_gpio_context m_gpio;
bool m_isrInstalled;
};
/**
* 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
*/
float flowRate();
protected:
wfs_context m_wfs;
private:
};
}