UPM

The UPM API is a high level sensor library for IoT devices using MRAA. See examples here. Back to index page.
SparkFun sensor images provided under CC BY-NC-SA-3.0.

WFS Class

Module: wfs

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.
wfs.jpg

Methods

WFS

(
  • pin
)
Number

Water Flow Sensor constructor

Parameters:

  • pin Number

    Digital pin to use

Returns:

Number:

getMillis

() Number

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

Returns:

Number:

Elapsed milliseconds

initClock

()

Resets the clock

clearFlowCounter

()

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

startFlowCounter

()

Starts the flow counter

stopFlowCounter

()

Stops the flow counter

flowCounter

() Number

Gets the flow counter

Returns:

Number:

Flow counter

flowRate

() Number

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.

Returns:

Number:

Computed flow rate