Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codehearts/light-bubble
🏮 A little project to control my bedroom lighting without invasive apps
https://github.com/codehearts/light-bubble
Last synced: 8 days ago
JSON representation
🏮 A little project to control my bedroom lighting without invasive apps
- Host: GitHub
- URL: https://github.com/codehearts/light-bubble
- Owner: codehearts
- License: mit
- Created: 2018-09-01T00:48:44.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-12T00:39:52.000Z (about 2 months ago)
- Last Synced: 2024-09-12T10:32:00.676Z (about 2 months ago)
- Language: JavaScript
- Homepage:
- Size: 758 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# light-bubble
A little project to control my bedroom lighting without invasive apps.
[![Build Status][build-badge]][build-link] [![Coverage][coverage-badge]][coverage-link]
## Configuration
Configuration is done via `config.json`. This repo includes a `config-sample.json` file which you can reference to start your own config. Available configurations are listed below:
- `port (int)`: Port for the light-bubble server to run on
- `host (str)`: Host for the light-bubble server to listen on
- `theme (str)`: Your preferred interface for light-bubble. Available themes are:
- default: A plain and understated theme
- horizon: Heavily inspired by a slice-of-life game I can't play yet
- `devices (arr of devices)`: Configurations for individual devices, in order of appearance on the interface
Supported devices and their configurations are listed below
### Tuya Outlet Configuration
- `make (str)`: `"tuya"`
- `model (str)`: `"outlet"`
- `config (obj)`: Configuration for the Tuya outlet
- `id (str)`: Unique ID for the device
- `key (str)`: API key for the device
- `ip (str)`: IP address of the device
- `title (str)`: Your name for the device
- `fields (arr of str)`: Your labels for each outlet on the device
## Local Setup
Once your configuration is set, you can start light-bubble on your configured port as follows:
```sh
npm start
```
## Docker Setup
First, move `config-sample.json` to `config.json` and configure as needed. Build the container, then run it on port 49160 (or whatever port you want):
```
docker build -t light-bubble .
docker run -p 49160:8080 -d light-bubble
```
## Themeing
light-bubble can be themed by creating the following files:
- `static/theme-${theme_name}/`
- `style.css`: stylesheet for the theme
- `icon.png`: a 192x192px png for the theme's app icon
- `manifest.webmanifest`: a webmanifest customized for the theme
Simply set the `theme` field in your `config.json` to the name of your theme, and you're done!
[coverage-badge]: https://img.shields.io/codecov/c/github/codehearts/light-bubble/master
[coverage-link]: https://codecov.io/gh/codehearts/light-bubble
[build-badge]: https://img.shields.io/github/workflow/status/codehearts/light-bubble/Test/master
[build-link]: https://github.com/codehearts/light-bubble/actions?query=workflow%3ATest+branch%3Amaster