Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonwakefield/anvil-web-app
Anvil-Web-App - Built with Anvil
https://github.com/jonwakefield/anvil-web-app
Last synced: about 1 month ago
JSON representation
Anvil-Web-App - Built with Anvil
- Host: GitHub
- URL: https://github.com/jonwakefield/anvil-web-app
- Owner: JonWakefield
- License: mit
- Created: 2023-11-15T15:02:16.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2023-11-30T16:47:26.000Z (about 1 year ago)
- Last Synced: 2023-11-30T22:41:12.289Z (about 1 year ago)
- Language: Python
- Homepage: https://anvil.works/build/apps/Q4SHJ3MMY7N3HANC
- Size: 611 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# PIDES Viewer
## Description:
This repository includes the complete code-base to setup, execute, and run the PIDES Viewer Anvil-web-app.
The PIDES Viewer web application is a website designed to enhance productivity by allowing for swift disgnosis
of plasic and HIE (Hand intrusion events) occurances through a gin stand.
## Table of Contents
- [Description](#description)
- [Website Features](#website-features)
- [Installation](#installation)
- [Startup Script](#startup-script)
- [Project Folders](#project-folders)
- [Database](#database)
- [Passwords](#passwords)
- [Contributions](#contributions)
- [License](#license)
## Website Features
- User-specific accounts and persistent login.
- Remote configuration of RPi Camera Settings.
- Ability to manage RPi camera nodes for setup, diagnosis, and installation.
- Website operates on users local network, ensuring isolated data protection
- Real time plastic detection alerts
- Real-time gin monitoring activity with easy-to-read charts.
## Installation
### Prerequisites:
- Ubuntu 20.04 64-bit AMD64. Compatibility with other distros is possible but untested.
### Steps
1. Clone git repository:
`git clone https://github.com/jonwakefield/anvil-web-app`
2. Make [startup.sh](/startup.sh) executable:
`chmod +x startup.sh`
3. Run startup.sh
`./startup.sh`
After running startup.sh, the anvil-web-app will be available for access on your local network via a Docker container.
### Website Access:
The website can be accessed on the same network as the server.
To access the website visit: https://:3030
replace with the host IP of the server.
The docker container is configured to auto-restart after a shutdown.
## Startup Script:
### Features
- Installs Git, Ansible, and sets up the complete PIDES Viewer environment.
### Steps
- [Server Setup Stage 1](DevOps/Ansible/server_setup_stage_1.yaml)
- [Server Setup Stage 2](DevOps/Ansible/server_setup_stage_2.yaml)
- [Server Setup Stage 4](DevOps/Ansible/server_setup_stage_4.yaml)
- Uses [Docker Compose file](DevOps/Docker/docker-compose.yaml) for container setup.
## Project Folders
It is important that both the [client_code](/client_code), [server_code](/server_code), and [theme](/theme) folders are not renamed.
### client_code
- All client-side code can be find within this folder.
- Each form has a `__init__.py` file accompanied by a `.yaml` file that deals with the UI elements
- To view the client-side and/or make changes to its layout, use Anvils easy-to-use GUI editor, by cloning this repository to your anvil account
### server_code
- Directory contains all server side code
- Client side calls to server code are routed through the [anvil_uplink_router](/server_code/anvil_uplink_router.py) module to the corresponding form module found in the [uplink_scripts](/server_code/uplink_scripts/) folder
- Each client-side form has a respective server side modulein the [uplink_scripts](/server_code/uplink_scripts) folder, allowing for a managable code structure.
Graphical Representation:
### theme
- Additonal CSS & HTML page layout and styling.
- See [Anvil Themes and Styling](https://anvil.works/docs/client/themes-and-styling) for more information
### DevOps
- Contains all Docker and Ansible related devops files.
## Database
- The primary database for this project is SQL
### Tables:
- Table: anvil_imgClassification
- Description:
Table used to store labels for images, path to images, and JOINT classifiers prediction.
- Files Used In:
picture_capture_controls.py
stack.py
Structure:
+----------+-----------+------+-----+---------+----------------+
| Field | Type | Null | Key | Default | Extra |
+----------+-----------+------+-----+---------+----------------+
| id | int(11) | NO | PRI | NULL | auto_increment |
| Cotton | char(32) | YES | | NULL | |
| Plastic | char(32) | YES | | NULL | |
| Tray | char(32) | YES | | NULL | |
| HID | char(32) | YES | | NULL | |
| Other | char(32) | YES | | NULL | |
| GotWrong | char(32) | YES | | NULL | |
| PATH | char(128) | YES | | NULL | |
| JOINT | char(32) | YES | | NULL | |
+----------+-----------+------+-----+---------+----------------+
- Table: anvil_imgProcessor
- Description:
Tables stores images & identification number on images that are currently being processed by the JOINT classifier
- Files Used In:
picture_capture_controls.py
Structure:
+-----------+-----------+------+-----+---------+----------------+
| Field | Type | Null | Key | Default | Extra |
+-----------+-----------+------+-----+---------+----------------+
| id | int(11) | NO | PRI | NULL | auto_increment |
| job_id | char(128) | YES | | NULL | |
| img_name | char(64) | YES | | NULL | |
| img_label | char(32) | YES | | NULL | |
+-----------+-----------+------+-----+---------+----------------+
- Table: users
- Description:
Table stores user info, role, hashed password, active gin and gins accessible. Users info must be stored in table for a user to log in
- Files Used In:
user_management.py
Structure:
+-----------------+--------------+------+-----+---------+----------------+
| Field | Type | Null | Key | Default | Extra |
+-----------------+--------------+------+-----+---------+----------------+
| id | int(11) | NO | PRI | NULL | auto_increment |
| username | varchar(64) | YES | | NULL | |
| email | varchar(64) | YES | | NULL | |
| password_hash | varchar(255) | YES | | NULL | |
| active_gin | varchar(64) | YES | | NULL | |
| role | varchar(64) | YES | | NULL | |
| gins_accessible | varchar(100) | YES | | NULL | |
+-----------------+--------------+------+-----+---------+----------------+
- Table: users_log
- Description:
Logs user activity including: login, logout, password change, and gin change
- Files Used In:
user_management.py
Structure:
+------------+-------------+------+-----+---------+----------------+
| Field | Type | Null | Key | Default | Extra |
+------------+-------------+------+-----+---------+----------------+
| id | int(11) | NO | PRI | NULL | auto_increment |
| email | varchar(64) | YES | | NULL | |
| role | varchar(64) | YES | | NULL | |
| active_gin | varchar(64) | YES | | NULL | |
| type | varchar(32) | YES | | NULL | |
| time | datetime | YES | | NULL | |
+------------+-------------+------+-----+---------+----------------+
- Table: log_user_request_acc
- Description:
Logs user account creation request. Does not have an connection to `users` table.
- Files Used In:
user_management.py
Structure:
+----------------+-------------+------+-----+---------+----------------+
| Field | Type | Null | Key | Default | Extra |
+----------------+-------------+------+-----+---------+----------------+
| id | int(11) | NO | PRI | NULL | auto_increment |
| firstname | varchar(64) | YES | | NULL | |
| lastname | varchar(64) | YES | | NULL | |
| email | varchar(64) | YES | | NULL | |
| gin_name | varchar(64) | YES | | NULL | |
| requested_role | varchar(64) | YES | | NULL | |
| time_requested | datetime | YES | | NULL | |
+----------------+-------------+------+-----+---------+----------------+
- Table: plastic_events
- Description:
Table that stores detected plastic events. Events are used to create graphs displayed to user.
- Files Used In:
bar_chart.py
Structure:
+---------------+-------------+------+-----+---------+----------------+
| Field | Type | Null | Key | Default | Extra |
+---------------+-------------+------+-----+---------+----------------+
| id | int(11) | NO | PRI | NULL | auto_increment |
| port | int(11) | YES | | NULL | |
| gin_name | varchar(40) | YES | | NULL | |
| gin_stand_num | int(11) | YES | | NULL | |
| gin_stand_pos | int(11) | YES | | NULL | |
| UTC | datetime | YES | | NULL | |
+---------------+-------------+------+-----+---------+----------------+
- Table: gins
- Description:
Stores basic gin info including gin name, number of gin stands,and location (state) of gin.
- Files Used In:
user_management.py
nodes_connected_uplink.py
Structure:
+----------------+-------------+------+-----+---------+----------------+
| Field | Type | Null | Key | Default | Extra |
+----------------+-------------+------+-----+---------+----------------+
| id | int(11) | NO | PRI | NULL | auto_increment |
| gin_name | varchar(32) | YES | | NULL | |
| num_gin_stands | int(10) | YES | | NULL | |
| location | varchar(32) | YES | | NULL | |
+----------------+-------------+------+-----+---------+----------------+
- Table: user_graph_settings
- Description:
Stores chart settings for each user allowing them to have user specific chart data
- Files Used In:
graphs/graphs_uplink.py
Structure:
+----------------+--------------+------+-----+---------+----------------+
| Field | Type | Null | Key | Default | Extra |
+----------------+--------------+------+-----+---------+----------------+
| id | int(11) | NO | PRI | NULL | auto_increment |
| DataSource | varchar(100) | YES | | NULL | |
| chart_type | varchar(20) | YES | | NULL | |
| chart_scale | varchar(40) | YES | | NULL | |
| x_title | varchar(100) | YES | | NULL | |
| y1_title | varchar(100) | YES | | NULL | |
| y2_title | varchar(100) | YES | | NULL | |
| y1_data_column | varchar(100) | YES | | NULL | |
| y2_data_column | varchar(100) | YES | | NULL | |
| xy_font_color | varchar(20) | YES | | NULL | |
| xy_font_size | int(11) | YES | | NULL | |
| title | varchar(200) | YES | | NULL | |
| title_color | varchar(20) | YES | | NULL | |
| column_colors | varchar(40) | YES | | NULL | |
| legend | tinyint(1) | YES | | NULL | |
| gin_name | varchar(40) | YES | | NULL | |
| num_gin_stands | int(10) | YES | | NULL | |
| user_email | varchar(40) | YES | | NULL | |
+----------------+--------------+------+-----+---------+----------------+
- Table: gin_stand_events
- Description:
Table stores detected gin events and location of image; allowing for retrieval and displaying of image to user.
- Files Used In:
gin_monitor_uplink.py
Structure:
+---------------+--------------+------+-----+---------+----------------+
| Field | Type | Null | Key | Default | Extra |
+---------------+--------------+------+-----+---------+----------------+
| id | int(11) | NO | PRI | NULL | auto_increment |
| gin_name | varchar(32) | YES | | NULL | |
| gin_stand_num | int(10) | YES | | NULL | |
| pic_age | int(11) | YES | | NULL | |
| file_name | varchar(120) | YES | | NULL | |
| HID_status | tinyint(1) | YES | | NULL | |
+---------------+--------------+------+-----+---------+----------------+
- Table: CamNodes_Info
- Description:
Table stores port # and location (gin name, gin stand num, and position) of port #, allowing for modification of camera settings on the correct node.
- Files Used In:
camera_controls_uplink.py
Structure:
+----+--------+------+----------+-------------+---------------------+
| id | Active | port | GinName | GinStandNum | GinStandPositionNum |
+----+--------+------+----------+-------------+---------------------+
| 16 | NULL | 3389 | Spade | 3 | 1 |
| 19 | NULL | 3306 | UCG | 2 | 1 |
| 20 | NULL | 3350 | Spade | 2 | 1 |
| 34 | NULL | 5400 | Spade | 2 | 1 |
| 35 | NULL | 6000 | Spade | 4 | 1 |
| 36 | NULL | 3333 | WhiteOak | 1 | 1 |
| 37 | NULL | 4444 | WhiteOak | 1 | 1 |
| 38 | NULL | 1234 | UCG | 3 | 1 |
+----+--------+------+----------+-------------+---------------------+
## Passwords:
Default passwords are provided for the SQL database, along with default login credentials.
Operaters can change the passwords to both the SQL database and the default login credentials.
### Changing SQL Credentials
To change the SQL credentials (username, password, database name), operators must modify 3 files:
1. Docker-compose.yaml file:
Lines 26-28:
- DATABASE_USER=new_db_username
- DATABASE_PASS=new_db_password
- DATABASE_NAME=new_db_name
Lines 46 - 48:
- MYSQL_DATABASE=new_db_name
- MYSQL_USER=new_db_username
- MYSQL_PASSWORD=new_db_password
2. init.sql file:
Lines 2-3:
CREATE DATABASE IF NOT EXISTS new_db_name;
USE new_db_name;
Lines 7-9:
CREATE USER 'new_db_username'@'maria-db' IDENTIFIED BY 'new_db_password';
GRANT ALL PRIVILEGES ON new_db_name.* TO 'new_db_username'@'maria-db';
FLUSH PRIVILEGES;
3. server_code/utils/DB_CREDIDENTIALS.py:
Lines 3-5:
DB_USERNAME = "new_db_username"
DB_PASSWORD = "new_db_password"
DB_NAME = "new_db_name"
### Changing Default website login credientials
The most convient way to change the default credientails is to loggin to the website using the default loggin, create a new admin account, and remove the old admin account.
#### Default login
email: Admin
password: Hello
### Have Db Credientials take effect:
To have changes to the database credientials take effect, the previous project build must be deleted and started ned.
1. Navigate to the projects directory. (By default this is ~/Desktop/local_website)
2. run: './build.sh'
## Contributions:
Contributors: Jonathan Wakefield, Dr. Mathew Pelletier, USDA - ARS
## License
The software source code files are released into the public domain as Open-Source Software with the license as dictated by the incorporated libraries utilized by our source code;
typical examples of applicable licenses are MIT and GNU Open-source licenses. The code is written in Python and utilizes only Open-source numerical, statistical, and machine-learning libraries.