jbarwick/homeworks-service repository overview

⁠Homeworks Service

I am writing this GPLv3. Let's all keep it in the community and share the code. DO NOT steal this code. Let's share.

As such, it's on GitHub here: https://github.com/jbarwick/homeworks-service⁠

Do note that inside the Docker image is "seed data" that is the Circuit names/addresses for my home system. I have not written a generic method to have you define our own network and seed data. This module does NOT FTP to the Lutron system to download configuration files or a map of your system.

⁠Notes

In the image are three files:

• circuit_zones.csv - all the circuits on your system. name, address, room, total_watts, dimmer_type
• keypads.csv - all the keypads on your system. name, address (stored to postgresql, but not used yet)
• users.csv - all the user accounts that can access the api. uuid, name, firstname, password (stored to postgresql, but not used yet)

Although keypads are not used in the program yet, the seed data is loaded.

Also, the configuration file is setup to connect to MY PostgreSQL server on my Synology NAS.

If you download this image, you will need to boot up the container and change ALL the configurations manually in application.properties

Share your ideas for the next features to add.

⁠Help Wanted!

I need YOUR help. I need advise on how I would make this container more configurable. It is up to the user of this container to set a bunch of properties, Have a REDIS and Postgresql server up and running (not included in this container).

To make this more generic and adoptable by users, should I do what other's do and build in EVERYTHING in the Container? Let me know your recommendations. Create the issue on GitHub https://github.com/jbarwick/homeworks-service/issues⁠

⁠Prometheus

This program provides a /metrics URL for Prometheus to read and I've a sample Graphana dashboard if you like.

I've added this application to target port 9992 as registered here: https://github.com/prometheus/prometheus/wiki/Default-port-allocations⁠

Currently, we're on 8080. Will change soon!

⁠Example of my Prometheus config

global:
  scrape_interval:     15s # Set the scrape interval to every 15 seconds. Default is every 1 minute.
  evaluation_interval: 15s # Evaluate rules every 15 seconds. The default is every 1 minute.
  # scrape_timeout is set to the global default (10s).

# Alertmanager configuration
alerting:
  alertmanagers:
  - static_configs:
    - targets:
      # - alertmanager:9093

rule_files:
  # - "first_rules.yml"
  # - "second_rules.yml"

scrape_configs:
  - job_name: 'prometheus'
    static_configs:
    - targets: ['localhost:9090']
  - job_name: 'lutron'
    static_configs:
    - targets: ['192.168.1.248:8080']

⁠Client UI's

And, I've a React web application that I'm writing to consume the /api in this program. Not included in this docker image

⁠Comments

Please enjoy and make recommendations...

This application

• polls the Homeworks system every 60 seconds for network status
• uses an internal REDIS database for storage of dimmer values
• uses a postgres database to store circuits, keypads, sort ranking for User Interfaces or web apps (in dev...there are no users yet), and
• calculates system total wattage and saves that information to PostgreSQL every 60 seconds (yes, your DB will grow...there is no 'purge' logic)
• provides a json API for a Web App to consume
• provides a /metrics endpoint for Prometheus. On Prometheous project, I said I'll put the metrics-exporter on 9992, but, I haven't created a listener here. Just use port 8080.. web port can't be changed at the moment. Or, this is just SpringBoot, you can modify application.properties.
• polls DIMMER values every HOUR for re-sync
• LISTENS for DIMMER value changes and updates REDIS as you change light levels
• DOES NOT interact in real-time with the Homeworks system. API is ALWAYS read from cache. Command processor actions are queued and run asynchronously. (option to 'wait' and make it synchronous...however, I do have a logic error/bug in the wait...can you guess what it is...I know what I did wrong...haven't had time to re-work it)