GroveWFS Class Reference

API for the Grove Water Flow Sensor. More...

Detailed Description

• ID: grovewfs
• Name: Grove Water Flow Sensor
• Category: liquid
• Manufacturer: seeed
• Link: http://www.seeedstudio.com/wiki/index.php?title=G1/2_Water_Flow_sensor
• Connection: gpio
• Kit: eak 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.

        // Instantiate a Grove Water Flow Sensor on digital pin D2
        upm_grovewfs.GroveWFS flow = new upm_grovewfs.GroveWFS(2);

        flow.clearFlowCounter();
        flow.startFlowCounter();

        while (true) {
            System.out.print("Millis: " + flow.getMillis() + " FlowCount: " + flow.flowCounter());
            System.out.println(" Flow Rate: " + flow.flowRate() + " LPM");

            Thread.sleep(2000);
        }

Public Member Functions
synchronized void	delete ()
	GroveWFS (int pin)
long	getMillis ()
void	initClock ()
void	clearFlowCounter ()
void	startFlowCounter ()
void	stopFlowCounter ()
long	flowCounter ()
float	flowRate ()

Constructor & Destructor Documentation

GroveWFS

(

int

pin

)

Grove Water Flow sensor constructor

Parameters

pin	Digital pin to use

Member Function Documentation

void clearFlowCounter

(

)

Resets the flow counter to 0. The flow counter should be stopped via stopFlowCounter() prior to calling this function.

long flowCounter

(

)

Gets the flow counter

Returns

Flow counter

float flowRate

(

)

Computes the flow rate in liters per minute (LPM)

Returns

Computed flow rate

long getMillis

(

)

Returns the number of milliseconds elapsed since initClock() was last called.

Returns

Elapsed milliseconds

void initClock

(

)

Resets the clock

void startFlowCounter

(

)

Starts the flow counter

void stopFlowCounter

(

)

Stops the flow counter

---

The documentation for this class was generated from the following file:

• /var/lib/jenkins/workspace/upm-doc-stable/build-33/src/grovewfs/GroveWFS.java