migit / tvraiser

TVRaiser is an idea sparked in mind when we observed useless TV screens in the store and raising them up from the dead to show some cool stuffs of other smart devices in the house. Eg coffee machine brewing status...

TVRaiser

TVRaiser is a program 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.

Features

TVRaiser 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. 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.

Troubleshooting

If you encounter issues while using TVRaiser, try the following troubleshooting steps:

• Issue: TVRaiser fails to start.

  • Solution: Make sure that you have installed all the required dependencies and run npm start again.

• Issue: TVRaiser displays incorrect information on the TV screen.

  • Solution: Check your card settings to make sure that they are displaying the correct information from your smart devices.

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.
• Support for custom functions and parameters.
• Improved data visualization through charts and graphs. Contributing

---

We welcome contributions to TVRaiser from other developers. To contribute, please follow these guidelines:

• Submit bug reports and feature requests through the issue tracker.
• Follow the coding standards and best practices outlined in CONTRIBUTING.md.
• Submit code contributions through pull requests, with a clear description of the changes you have made.

Improvements to API

TVRaiser is constantly evolving, and we are always looking for ways to improve its API. If you have any suggestions or feedback, we'd love to hear from you.

License

This program is licensed under the GNU License.

tvraiser's Issues

Ownership

Hey. Can I have the ownership of this repository?

My account is pro and if I have ownership I could write a wiki page for this repository. Also I more actively work on the project. And ownership would limit me less.

Benefits

• wiki
• others

Wiki and documentation

Wiki and documentation

We should add a Wiki and some documentation. on the:

• Use of the frontend
• Use of the backend

For this completion #1 is required at least for GitHub own systems

Frontend functions

Frontend functions

What frontend functions should be added? Already multiple exist but what should be added?

Maybe also some kind of backend implementation where you can add your own functions would be a good idea by maybe straight JavaScript being passed along. to the frontend.

Ideas wanted

The backend needs work done

Backend needs work

The backend needs some new features. And also refinement.

Features

• frontend
• improvements to API
• Accounts to enable guest users via QR code and also have higher and lower backend users with restrictions that should be able to be modified

Front end should include

• Card creation
• Settings like themes and maybe theme creation. also page change and language

Card creation requires these fields (These field should be modular enough to make it easy to add more entries when program evolves)

• automatic id (Not required but good practice)
• Card header (Name of card also defines the ids of card parts from this)
• Card content (Array that consist of the entries in the card each array object becomes its own line)
• Card size (Determines the size of the card. This should be maybe a dropdown with options ranging from None, Small, Medium, Large, XLarge, XXLarge, XXXLarge)
• Card Icon (Determines the icon for the card. Also should be a dropdown with options ranging from None, Info, Warning, Bell, Question, Clock, Sun, Moon, Cloud, CoffeeMug, Calender )
• Card animation (Determines the animation of the card icon. This too should be a dropdown with options ranging from None, Pulse, Fade, Beat, Bounce, Spin, Shake)
• Card Function (This is the most complex. It adds functions to the cards. These functions require some parameters depending on the function. Most functions so far require the CardSlot variables that determine the slot of the card to change in the card way.)

Functions and their parameters

• CoffeeStatus (FirstCardSlot (Status), SecondCardSlot (Description), ThirdCardSlot (Level), FourthCardSlot (Temperature))
• WeatherStatus (FirstCardSlot (Weather Status), SecondCardSlot (Current temparature), ThirdCardSlot (Longitude), FourthCardSlot (latitude))
• TimeStatus(FirstCardSlot (Current time), SecondCardSlot (Current Date))
• updateNotifications (FirstCardSlot (Notification), SecondCardSlot (Notification timestamp))
• CreateChart (FirstCardSlot (Slot for chart), SecondCardSlot (Description), FirstParameter (chart type), SecondParameter (Labels Array), ThirdParameter (Label), FourthParameter (Values Array))