cos301-se-2021 / e-park-smart-water-monitor

Dynative - E-Park Water Monitor - A system designed to modernize the monitoring of water sources in the national parks and game reserves of Southern Africa with a focus on reliability and efficiency. E-Park uses IoT devices to remotely manage this often overlooked part of park maintenance. It makes use of smart algorithms and artificial intelligence to predict scenarios in order to stay ahead of the curb, potentially preventing disaster while also making the jobs of park rangers and conservationists easier as well as lowering costs by eliminating unnecessary inspections and maintenance.

 

Dynative

E-Park Smart Water Monitor

📱 💧 📈

A system designed to modernize the monitoring of water sources in the national parks and game reserves of Southern Africa with a focus on reliability and efficiency. E-Park uses IoT devices to remotely manage this often overlooked part of park maintenance. It makes use of smart algorithms and artificial intelligence to predict scenarios in order to stay ahead of the curb, potentially preventing disaster while also making the jobs of park rangers and conservationists easier as well as lowering costs by eliminating unnecessary inspections and maintenance.

Project

SRS DEMO1

SRS DEMO2

SRS DEMO3

SRS DEMO4

Demo 1 Video

Demo 2 Video

Demo 3 Video

Demo 4 Video

Architectural Requirements Demo 2

Architectural Requirements Demo 3

Architectural Requirements Demo 4

Coding Conventions

User Manual

Installation Manual

Testing Policy Document

📋 Table of Contents

1. Branching Strategy
2. Technologies
3. The Team

🔱 Branching Strategy

Monorepo & Git Flow

• master
  • development
    • feature/FE (frontend feature)
    • bugfix/BE (backend bugfix)
    • feature/FS (fullstack feature)
    • test/MC (microcontroller test addition)
    • ...

💡 Technologies

Frontend

Backend

Hosting

CMS

CI

Code Coverage

Dependencies

Monitoring

Project Management

🐘 The Team

Rolan Strydom

Group Leader and Backend Developer

 

Joanita Nell

Fullstack Developer

 

Abel Jansen

Backend and Embedded Systems Developer

 

Janlu Pretorius

Fullstack Developer

 

Michaela Shormann

Frontend Designer and Developer

 

e-park-smart-water-monitor's Issues

Secure microcontroller requests

Add "secrets" to verify authenticity of device post requests.

Create Demo Video

Complete SRS

• Introduction @TheySeeMeRolan
• Fix class diagram @TheySeeMeRolan
• Quality Requirements @JLooping @glithcy
• User characteristics @JoanitaNell
• Use case Diagram @glithcy
• Traceability Matrix @JoanitaNell
• Service Contracts
• User Characteristics @JoanitaNell
• Notifications @TheySeeMeRolan
• Push data from controller

Add additional database functionality for adding sites and measurements

• Add sites
• add relationships between devices and sites
• add infrastructure devices

Extract common device attributes into object

• Create a deviceData class that will be a member variable of the classes:
  WaterSourceDevice.java and InfrastructureDevice.java

Implement Monitoring Dashboard

Implement monitor dashboard.

Implement Login

Fix frontend template issues

Fix the frontent so that we can run development and production builds.

Setup Spring Boot

• Setup base folders/classes

Cleanup React codebase

• Split dashboard component into subcomponents (cards, tables)
• Remove comments and unused code
• Remove unused dependencies (eslint, gulp etc.)
• Remove register page
• Change codebase naming structure

Upload microcontroller code to repo

Add requested api endpoints

• Add getParkDetails endpoint
• Add getParkSites endpoint

Change backend requests to PUT

Inter system coms set up for ServiceDevice

Style login page

Use design to style login page.

Frontend

Design and building of the React frontend.

Meeting with client

Questions:

• Hardware, LoraWan
• Weather data?
• Elaborate on users. What is a field engineer?

Display Dashboard Data

Request simple data from db to display on dashboard.
This includes for the map and attempting to implement all endpoints possible with the elements currently on the front end.

Login authentication

Implement OAuth or JWT token authentication for login.

Microcontroller authentication

Setup time series database

Setup Dashboard Controller in SpringBoot

Frontend login functionality

Build frontend login functionality using requests on the login page

Research React mobile porting

Look into converting the webapp to a mobile app.

Add additional API endpoints

• Add getNumDevices of a park

Unit Tests

• Park
• Devices
• WaterSites

Style Monitoring Dashboard

Use design to style the layout of the dashboard.

Setup Neo4j DB

• Host database
• Link to Spring Boot

Change frontend connection to hosted backend

Change queries from localhost to heroku.

Setup environment variables for backend urls.

General backend cleanup

• Change response methods to be more consistent
• Remove commented or unused code
• Remove auto-generated tests

Implement Send Notification Use Case

Fix deviceData Construction

Add duplicate database entry check

Design Site Layout

• Dashboard
• Profile
• Device
• Admin

View Dashboard Use Case

Add get all park's devices

Add api endpoint to get all the devices associated with a park, search by id.

Adjust different devices to hold a compositional device class for shared attributes

Set up react

Setup base react enviroment

Microcontroller authentication

Microcontroller

Code to relating to and to be deployed to the microcontrollers.

Design login page

Design login page layout.

Convert SourceData to Measurements

• measurements class added
• measurements class integrated with other systems

Change to search by ID

Implement Microcontroller Data Send

Send any data from controller to db.

Implement Dashboard Map

Added the leaflet map to the dashboard
created an additional device page without styling
need to get backend code to populate our elements

Change receiveDeviceDataRequest

Backend

Design and building of the Springboot backend.

Initial Functional Requirements List

Documentation

Tickets relating to the university admin side of the project.

Backend Login Functionality

Build login controllers and endpoints