Skip to content

Collect fluid flow data and publish it to a server that can alert about annomalies

Notifications You must be signed in to change notification settings

soonick/smart-fluid-flow-meter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Smart Fluid Flow Meter

CircleCI

Hardware and software for a system that monitors flow of fluids (most likely water) and reports it to a back-end that can emit alerts based on configured preferences.

  • backend - Contains the back end server where measurements will be posted
  • case - 3d model of the PCB case
  • esp32 - The ESP32 code that takes care of reading the sensor and posting measurements to the back-end
  • frontend - The front end that can be used to manage accounts and devices
  • kicad - Electronic circuit schematic

User documentation

LED indicators

  • Yellow - Device is booting
  • Green, yellow and red - Device set to factory settings and waiting for configuration (See below for instructions to configure)
  • Green - Device is configured and behaving correctly
  • Green and yellow - Device is in the middle of sending a request to the back-end
  • Red - Last request to back-end failed. This could be because configuration is incorrect, or the configured modem is unreachable
  • None - This should not happen, it means something is very wrong

Configuration

When the device is in factory settings (Green, yellow and red LEDs on), the ESP32 will start an access point named my-esp32-ssid. Connect to the access point using the password APassword.

Once connected, navigate to the url: sffm.ncona.com. You should get a screen like the following:

Configure device screen

Fill the data as follows:

  • Wifi Network - The name of the network the device will connect to
  • Wifi Password - The password for the given SSID
  • Device key - The unique identifier for this device. This ID will be validated by the backend, so it must be a valid one

After submitting the form, you should get the following confirmation screen:

Configuration saved screen

The device will proceed to disable the access point and will start reading measurements from the sensor and sending them to the backend every MS_BETWEEN_POSTS.

Factory reset

If you need to re-configure the device, press and hold the device button for 5 seconds. After some time the green, yellow and red LEDs should all turn on.

About

Collect fluid flow data and publish it to a server that can alert about annomalies

Resources

Stars

Watchers

Forks

Packages

No packages published