{"id":22128564,"url":"https://github.com/rangerdigital/darkness","last_synced_at":"2026-04-18T15:40:25.487Z","repository":{"id":119120030,"uuid":"236553216","full_name":"RangerDigital/darkness","owner":"RangerDigital","description":"⚔ The fastest and simplest way to get started with NeoPixels on your Raspberry Pi!","archived":false,"fork":false,"pushed_at":"2021-02-06T18:02:29.000Z","size":1901,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-24T08:48:30.584Z","etag":null,"topics":["darkness","darkness-cli","flask","flask-api","home-automation","lights","neopixels","notifications","python3","raspberry-pi"],"latest_commit_sha":null,"homepage":"https://darkness.bednarski.dev/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RangerDigital.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-27T17:46:22.000Z","updated_at":"2024-07-30T01:21:23.000Z","dependencies_parsed_at":"2023-05-31T02:30:52.322Z","dependency_job_id":null,"html_url":"https://github.com/RangerDigital/darkness","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/RangerDigital/darkness","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RangerDigital%2Fdarkness","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RangerDigital%2Fdarkness/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RangerDigital%2Fdarkness/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RangerDigital%2Fdarkness/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RangerDigital","download_url":"https://codeload.github.com/RangerDigital/darkness/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RangerDigital%2Fdarkness/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31974952,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T00:39:45.007Z","status":"online","status_checked_at":"2026-04-18T02:00:07.018Z","response_time":103,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["darkness","darkness-cli","flask","flask-api","home-automation","lights","neopixels","notifications","python3","raspberry-pi"],"created_at":"2024-12-01T17:45:58.153Z","updated_at":"2026-04-18T15:40:25.457Z","avatar_url":"https://github.com/RangerDigital.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cbr /\u003e\u003cimg\n    width=\"600\"\n    src=\"logo.png\"\n    alt=\"Darkness – NeoPixels Controller\"\n  /\u003e\n\u003c/p\u003e\n\n***\n\n![Build - Documentation](https://github.com/RangerDigital/darkness/workflows/Build%20-%20Documentation/badge.svg?branch=master)\n![Build - Dev](https://github.com/RangerDigital/darkness/workflows/Build%20-%20Dev/badge.svg?branch=dev)\n![Build - Production](https://github.com/RangerDigital/darkness/workflows/Build%20-%20Production/badge.svg?branch=master)\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n\n**Darkness** is a simple dockerized **Flask API** used to control **NeoPixels** strips connected to **Raspberry Pi**.\n\n\u003e 📚 For more information go to [Darkness](https://darkness.bednarski.dev/) official site!\n\n\u003cbr\u003e\n\n\n## 🍬 Features\nThe most noticeable features currently implemented in Darkness:\n- **Run as a Docker container**, simple to get started.\n- **Python API**, lightweight Flask powered API.\n- **Animation System,** flexible way to show notifications.\n- **Command Line client**, by using Darkness CLI you can integrate anything.\n\n\u003cbr\u003e\n\n\n## 🔥 Setup\n**Darkness** is run as a Docker container, you can try it out with commands below.\n\nThis runs a container with minimal setup required:\n\n```bash\ndocker run --name darkness --cap-add SYS_RAWIO --device /dev/mem --device /dev/vcio -p 5000:8000 rangerdigital/darkness\n```\n\n\u003e🔨 You can specify LED count `-e LED_COUNT=16`, (Default: 16) and GPIO port `-e LED_GPIO=18`, Default: 18).\n\nOr in case It doesn't work:\n\n```bash\ndocker run --name darkness --privileged -p 5000:8000 rangerdigital/darkness\n```\n\n\u003e🔪 The privileged flag is seriously **insecure**, I wouldn't trust me if I were you!\n\n\u003cbr\u003e\n\n\n## 🎉 Usage\nYou can use **Darkness CLI** client control Darkness running on your Raspberry Pi by installing it with the command below:\n```bash\ncurl https://darkness.bednarski.dev/install.sh | sudo bash\n```\n\n\u003cp align=\"center\"\u003e\n\t\u003cimg src=\"docs\\.vuepress\\public\\terminal.gif\" alt=\"Darkness CLI Terminal\" width=750/\u003e\n\u003c/p\u003e\n\nCurrently supports **only Linux** distributions, or If you want to have full control use **Darkness API**.\n\nThe easiest way to start is to run **GET** requests against `/state` endpoint,\nwith **POST** or **PUT** you can update these values to control still ambient light.\n```json\n{\n\"hue\":  360,\n\"saturation\":  1,\n\"status\":  true,\n\"value\":  1\n}\n```\nIf you want to see the rainbow animation just **POST** or **PUT** to `/animations/rainbow`.\n```json\n{\n\"msg\":  \"Rainbow animation completed!\"\n}\n```\nYou can specify duration of the animation with **URL parameters**,\nfor example: `/animations/rainbow?duration=10` will play rainbow animation for 10 seconds.\n\n\u003e💡 For full API documentation go to [Darkness](https://darkness.bednarski.dev/) official site!\n\n\u003cbr\u003e\n\n## 🚧 Contributing\n\n**You are more than welcome to help me build the Darkness!**\n\nJust fork this project from the `master` branch and submit a Pull Request (PR) to the `dev` branch.\nIf you are modifying the Darkness server you should also run `pytest` functional tests inside `/darkness/tests` directory.\n\n\u003cbr\u003e\n\n## 📃 License\nThis project is licensed under [GPL-3.0](https://choosealicense.com/licenses/gpl-3.0/) .\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frangerdigital%2Fdarkness","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frangerdigital%2Fdarkness","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frangerdigital%2Fdarkness/lists"}