Skip to content

benjaminfuchs/nerd-colors

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

nerd-colors

A Pi-Zero W based led light with an web-interface to control the color and brightness.

Table of Contents

  1. News and Status
  2. Installation
  3. Hardware
  4. Prerequisites
  5. Configuration
  6. Usage
  7. Hacking

News

As always, the software and documentation is work in progress. A detailed list of functions (current and planned) is available in the document Features. Nevertheless, once in a while I will release a stable version.

Available branches:

  • stable_v?: stable versions (frozen)
  • master: the current stable branch plus fixes
  • next: the bleeding-edge development version with new features, but possibly unstable

next / work in progress

Planned features:

  • sound controlled lights

stable_v1 / Jan 6, 2018

First productive version. All basic features working.

Prerequisites

Besides the hardware-modules listed in section Hardware and the software-environment described in Installation there are no special prerequisites.

Hardware

From hardware-side, you need

Installation

As a prerequisite, you need a basic install of Raspbian Stretch-Lite.

Use the following commands to install the software:

git clone https://github.com/benjaminfuchs/nerd-colors.git
cd nerd-colors
sudo tools/install

This will pull-in all dependencies, install the software, create technical users and do a basic configuration of the system. Since the install command changes the file /boot/config.txt, you need a reboot to activate the changes.

Upgrade

Before uprading an existing system, you should stop the relevant system services:

sudo systemctl stop nerd-colors.service

Then run a normal install like documented above. After installation, you should update you existing /etc/nerd-colors.conf from the file /etc/nerd-colors.conf.nerd-colors.

Configuration

System services

Edit the file /etc/nerd-colors.conf to configure the systemd-service running the clock.

Manual configuration

Program defaults are in the file /var/lib/nerd-colors/defaults.json. You should not edit this file directly (unless you know what you are doing). After first run, the settings are saved in /var/lib/nerd-colors/settings.json. You can edit this file manually, but you should make sure the clock-service is stopped before doing so (it will be otherwise overwritten).

Usage

After initial configuration as explained above, restart the system and then it should just run. You can than use web-interface to change the color and brightness or change other settings.

Hacking

If you want to change the code and adapt it for your needs, you need some python know-how and you have to understand the structure of the program. For details read the hacking-guide.

Credits

Big thanks to Bernhard Bablok for his nerd-alarmclock which was used as template for this project.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published