pyupm_wfs module

class pyupm_wfs.WFS(pin)[source]

Bases: object

API for the Water Flow Sensor.

ID: wfs

Name: Water Flow Sensor

Other Names: Grove Water Flow Sensor

Category: liquid

Manufacturer: seeed

Link:http://wiki.seeedstudio.com/wiki/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.

C++ includes: wfs.hpp

clearFlowCounter()[source]

void clearFlowCounter()

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

flowCounter()[source]

uint32_t flowCounter()

Gets the flow counter

Flow counter

flowRate()[source]

float flowRate()

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.

Computed flow rate

getMillis()[source]

uint32_t getMillis()

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

Elapsed milliseconds

initClock()[source]

void initClock()

Resets the clock

startFlowCounter()[source]

void startFlowCounter()

Starts the flow counter

stopFlowCounter()[source]

void stopFlowCounter()

Stops the flow counter