Skip to content
This repository has been archived by the owner on Feb 19, 2024. It is now read-only.

Latest commit

 

History

History
70 lines (49 loc) · 6.02 KB

README.md

File metadata and controls

70 lines (49 loc) · 6.02 KB
Raw

This repo is going READONLY

💻 Digital Alchemy Monorepo 🔮

Description

@digital-alchemy is a collections of projects built on top of the NestJS framework. The repository is a collection of general purpose modules for building premium terminal applications, microservices, home automation logic, and more. Modules are intended to be composed in any combination to build a desired application.

🛠️ Projects

🏡 Home Assistant / Automation ⏳

A docker based reference install provided to try out code without affecting an existing instance

Local NPM Tags Notes
📂 Automation Logic npm
  • nestjs_library
  • home_assistant
  • generated_types
 Canned automation logic, scene management, and more!
📂 Home Assistant npm
  • nestjs_library
  • home_assistant
  • generated_types
 Websocket and rest api bindings for Home Assistant. Generates custom types based on your install
🎬 Entity Creation N/A
  • home_assistant
  • example_code
 Example code for generating basic push entities using @digital-alchemy/home-assistant
🎬 Scene Manager N/A
  • home_assistant
  • example_code
 Example code for creating scene managed rooms using @digital-alchemy/automation-logic

🖥️ Terminal Applications 🕹️

Local NPM Tags Notes
📂 TTY npm
  • nestjs_library
  • tty
 Prompts, canned components, rendering utilities, and keyboard interactions inside of the terminal
👀 Sampler App N/A
  • example_code
  • try me!
 Demo app for tty library functionality. Get a quick feel for how things look and work from inside your terminal
🔬 Hass CLI N/A
  • home_assistant
  • example_code
 Interactions with Home Assistant via terminal app. More development aid than functional tool.
👀 Game of Life N/A
  • rgb_matrix
  • example_code
  • experiment
  • try me!
 An implementation of Conway’s Game of Life with controls via tty library. Optional state mirroring to a pi-matrix-client compatible display
🔬 Config Builder N/A
  • experiment
 Experimental application: terminal based application for manipulating config files compatible with this repo

🖼️ RGB Matrix 🚦

Hardware build guide

Local NPM Tags Notes
👀 Pi Matrix npm
  • application
 Simple application wrapper for @digital-alchemy/pi-matrix-client
📂 Pi Matrix Client npm
  • native_bindings
  • nestjs_library
 Code intended to run on a pi / similar. Performs rendering functions.
📂 Render Utils npm
  • shared
  • nestjs_library
 Generic math and utility functions for rgb matrix displays and terminal apps
📂 Rgb Matrix npm
  • client
  • nestjs_library
 Layout and rendering utilities for arduino rgb matrix displays

🗜️ Meta / Other 🪆

Local NPM Tags Notes
🎬 Notification Tester N/A
  • example_code
 Simple example of how to import gotify into an app, and send notifications
📂 Boilerplate npm
  • nestjs_library
 Bootstrapping, configuration, logging, and other basics
📂 Gotify npm
  • nestjs_library
 Application bindings for sending notifications though Gotify
📂 MQTT npm
  • nestjs_library
 Basic MQTT bindings
📂 Server npm
  • nestjs_library
 Http server support, standard ssl & middleware configurations, request logging
📂 Testing npm
  • nestjs_library
 Extensions to NestJS unit testing to be compatible with @digital-alchemy apps
📂 Utilities npm
  • shared
 Standard utilities and constants used across the repository
🔬 Log Formatter npm
  • experiment
 Pipe (|) friendly tool to reformat pino json logs to pretty logs

External Examples

Basic Application

Home Automation

A working implementation of a home automation application. Intended to show the automation-logic & home-assistant libraries being used