TVRaiser is an open source platform that aims to repurpose idle TV screens by displaying useful information from other smart devices in your home or office. With TVRaiser, you can check the status of your coffee machine, view the contents of your fridge, and more, all from the comfort of your TV screen. TVRaiser is a system architecture that let's you integrate home automation and back end office app to display status , notifications and information as a widget or card in a modern smart TV screen. The main purpose of this project is to demonstrate an esp32 microcontroller to push notifications (coffee brew status) in a web server and The data is pulled through the TV app and gets displayed as a widget card as a proof of concept.
FeaturesTVRaiser comes with a range of features that make it a versatile and user-friendly program. These features include:
Frontend
TVRaiser's frontend allows you to easily create and customize cards, which display the information from your smart devices. The frontend includes:
- Card creation: You can create custom cards with modular fields, making it easy to add new entries as the program evolves.
- Settings: TVRaiser allows you to customize themes, page changes, and language settings.
- Card fields: When creating a card, you can add the following fields:
- Automatic ID (recommended)
- Card header (name of card, which also defines the IDs of card parts)
- Card content (array of entries that each become their own line)
- Card size (dropdown menu with options ranging from None to XXXLarge)
- Card icon (dropdown menu with options ranging from None to CoffeeMug, Moon, and more)
- Card animation (dropdown menu with options ranging from None to Shake, Spin, and more)
- Card function (adds functions to the cards, requiring some parameters depending on the function)
Functions and Parameters
TVRaiser comes with a range of functions and parameters that allow you to display a variety of useful information on your TV screen that publishes throughthe ESP32 microcontroller. These functions include:
- CoffeeStatus: Displays the status, description, level, and temperature of your coffee machine.
- WeatherStatus: Displays the weather status, current temperature, longitude, and latitude.
- TimeStatus: Displays the current time and date.
- UpdateNotifications: Displays notification updates and timestamps.
- CreateChart: Creates a chart with a slot, description, chart type, labels array, label, and values array.
Installation
To install TVRaiser, follow these steps:
Clone the repository to your local machine.
1. Install the required dependencies by running npm install.
2. Start the application by running npm start.
3. Getting Started
To create a new card in TVRaiser, follow these steps:
1. Open the TVRaiser backend frontend by navigating to localhost:3000 in your browser.
2. Click the "Create New Card" button.
3. Customize the card settings by adding modular fields, including automatic ID, card header, card content, card size, card icon, card animation, and card function.
4. Save your new card and it will be displayed on your TV screen.
Roadmap
We are planning to add the following features to TVRaiser in the near future:
- Integration with additional smart devices, such as smart thermostats and security systems, healthmonitoring devices etc...
- Support for custom functions and parameters.
- Improved data visualization through charts and graphs.
Comments