Skip to content

objektwerks/pool.balance

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2,820 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pool Balance

Pool balance app using ScalaFx, ScalikeJdbc, Jsoniter, JoddMail, PostgreSql, HikariCP, Helidon, Ox and Scala 3.

Todo

  1. Test client.

Build

  1. sbt clean compile

Test

  1. sbt clean test

Server Run

  1. sbt server/run

Client Run

  1. sbt client/run

Package Server

  1. sbt server/universal:packageBin
  2. see server/target/universal

Client Assembly

  1. sbt clean test assembly copyAssemblyJar

Execute Client

  1. java -jar .assembly/pool-balance-$version.jar ( or double-click executable jar )

Deploy

Consider these options:

  1. jDeploy
  2. Conveyor

Features

  1. dashboard
  2. cleanings
  3. measurements
  4. chemicals
  5. charts
  6. database

Use Cases

  1. clean pool and components
  2. measure pool chemical content
  3. add chemicals to pool

Entity

  • Pool 1 --> * Cleaning | Measurement | Chemical

Model

  • Client 1 --> 1 Context
  • Conext 1 --> 1 Model | View
  • Model 1 --> 1 Proxy
  • View 1 --> 1 Context

UI

  1. Top: dashboard(total chlorine, free chlorine, ph, calcium hardness, total alkalinity, cyanuric acid, total bromine)
  2. Left: pane(pools)
  3. Right: tabbedpane(cleanings, measurements, chemicals)

Charts

  • cleanings - line chart ( x = cleaned, y = count of [true] cleanings )
  • chemicals - line chart ( x = added, y = chemical )
  • measurements - line chart ( x = measured, y = measurement )

Measurements

Measured in ppm ( parts per million ).

Measurement Range Good Ideal
total chlorine (tc = fc + cc) 0 - 10 1 - 5 3
free chlorine (fc) 0 - 10 1 - 5 3
combinded chlorine (cc = tc - fc) 0.0 - 0.5 0.0 - 0.2 0.0
ph 6.2 - 8.4 7.2 - 7.6 7.4
calcium hardness 0 - 1000 250 - 500 375
total alkalinity 0 - 240 80 - 120 100
cyanuric acid 0 - 300 30 - 100 50
total bromine 0 - 20 2 - 10 5
salt 0 - 3600 2700 - 3400 3200
temperature 50 - 100 75 - 85 82

Chemicals

  • Liquids measured in: gallons ( gl ) and liters ( l ).
  • Granules measured in: pounds ( lbs ) and kilograms ( kg ).
  1. LiquidChlorine ( gl/l )
  2. Trichlor ( tablet )
  3. Dichlor ( lbs/kg )
  4. CalciumHypochlorite ( lbs/kg )
  5. Stabilizer ( lbs/kg )
  6. Algaecide ( gl/l )
  7. MuriaticAcid ( gl/l )
  8. Salt ( lbs/kg )

Products

  1. Chlorine for pool.
  2. Chlorine tablets for pool filtration system.
  3. Pool Shock

Solutions

Suggested solutions to chemical imbalances.

  1. high ph - Sodium Bisulfate
  2. low ph - Sodium Carbonate, Soda Ash
  3. high alkalinity - Muriatic Acid, Sodium Bisulfate
  4. low alkalinity - Sodium Bicarbonate, Baking Soda
  5. calcium hardness - Calcium Chloride
  6. low chlorine - Chlorine Tablets, Granules, Liquid
  7. algae - Algaecide, Shock
  8. stains - Stain Identification Kit, Stain Remover

Postgresql

  1. config:
    1. on osx intel: /usr/local/var/postgres/postgresql.config : listen_addresses = ‘localhost’, port = 5432
    2. on osx m1: /opt/homebrew/var/postgres/postgresql.config : listen_addresses = ‘localhost’, port = 5432
  2. run:
    1. brew services start postgresql@14
  3. logs:
    1. on osx intel: /usr/local/var/log/postgres.log
    2. on m1: /opt/homebrew/var/log/postgres.log

Database

Example database url: postgresql://localhost:5432/poolbalance?user=mycomputername&password=poolbalance"

  1. psql postgres
  2. CREATE DATABASE poolbalance OWNER [your computer name];
  3. GRANT ALL PRIVILEGES ON DATABASE poolbalance TO [your computer name];
  4. \l
  5. \q
  6. psql poolbalance
  7. \i ddl.sql
  8. \q

DDL

Alternatively run: psql -d poolbalance -f ddl.sql

  1. psql poolbalance
  2. \i ddl.sql
  3. \q

Drop

  1. psql postgres
  2. drop database poolbalance;
  3. \q

Environment

The following environment variables must be defined:

export POOL_BALANCE_HOST="127.0.0.1"
export POOL_BALANCE_PORT=7272
export POOL_BALANCE_ENDPOINT="/command"

export POOL_BALANCE_CACHE_INITIAL_SIZE=4
export POOL_BALANCE_CACHE_MAX_SIZE=10
export POOL_BALANCE_CACHE_EXPIRE_AFTER=24

export POOL_BALANCE_POSTGRESQL_DRIVER="org.postgresql.ds.PGSimpleDataSource"
export POOL_BALANCE_POSTGRESQL_URL="jdbc:postgresql://localhost:5432/poolbalance"
export POOL_BALANCE_POSTGRESQL_USER="yourusername"
export POOL_BALANCE_POSTGRESQL_PASSWORD="poolbalance"

export POOL_BALANCE_EMAIL_HOST="your-email.provider.com"
export POOL_BALANCE_EMAIL_ADDRESS="your-email@provider.com"
export POOL_BALANCE_EMAIL_PASSWORD="your-email-password"

Resources

License

Copyright (c) [2022 - 2025] [Objektwerks]

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

* http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

Pool balancing app using ScalaFx, ScalikeJdbc, Jsoniter, JoddMail, Helidon, Ox, PostgreSql, HikariCP and Scala 3.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors