[{"_1":2,"_156":-5,"_157":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_135":136},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_126":-5,"_127":11,"_128":17,"_129":11,"_130":-5,"_131":11,"_132":-5,"_133":134},"canonicalUrl","https://hub.docker.com/r/johnthenerd/lightapi/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","johnthenerd","reponame","lightapi","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":11,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2019-02-08T02:58:05.203705Z","description","https://github.com/JohnTheNerd/lightAPI","is_private","last_updated","2022-06-12T19:15:47.261774Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",29122,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# lightAPI\n\nA simplistic smart lighting application written in Python 3. It has a Flask-based API to control all light functionality. I run it on my little Raspberry Pi to manage my lights (and popcorn maker). It currently only works with the HS100 smartplug and LifX/Yeelight bulbs. It is also possible to implement all the functions in `devices/yeelight.py` for any device, which will make the API automatically able to communicate to the bulb by setting the filename as `brand` in the configuration file.\n\nEverything in the API works as GET requests - this is an intentional design decision. This allows one to trigger any function in the API straight from the browser!\n\n## Usage\n\n- Clone this repository.\n\n- Install all the requirements by running `pip3 install pyHS100 flask lifxlan`.\n\n- Rename `config.dist.json` to `config.json`.\n\n- Open `config.json` in any text editor and change variables as necessary. All times are in seconds.\n - **Lights**: Define groups of lights here. `multizone` represents a LifX Z, and mac/ip should be self-explanatory.\n - **Colors**: All colors are lists of four numbers, as can be seen in the configuration.\n - **Passwords**: The passwords needed for certain API endpoints. All passwords are SHA-512 hashes of the actual password\n - **Alarm**: `initialFadeIn` is the amount of time cyan light initially fades in, `duration` is the total duration of the alarm, and `colorChangeFrequency` is how often the color will rotate after the initial fade-in. You could install `ffplay` and put a file under the alarm directory named `alarm.mp3` if you'd like to hear an alarm too. If you don't have any form of sensitivity to flashing shiny lights and just _need_ to get out of bed, you could change the `mode` to `insane`. If you do so, you must also:\n - Define `colors` as a list of colors you'd like to use.\n - You may define `slack` to automatically post to a Slack channel a certain period after the alarm starts, if it's still running of course. If you do so, you must also define all the options you can find under `config.dist.json`.\n - If running on Docker, define `hostIP` as the IP address of the computer this is running on.\n - **Camera**: E-mail options for the camera setting.\n - **Plug**: Optional field, if not used must be entirely removed. `ip` is the IP address of your HS100 smart plug, `offTimer` is an optional timer set for the on command, and `onRoutes`/`offRoutes` are the additional endpoints used to control the plug.\n - **skipGroups**: A list of groups which are to be skipped when looking for all lights.\n - **myIP**: Must correspond to your local IP address. `0.0.0.0` may work if you want to have it wide open, `127.0.0.1` will lock it down to your local computer\n - **hosts**: Optional field, must be an array of strings if used. If the \"Host\" header does not match one of the hosts provided here (don't include http:// or the port), the connection will be rejected. Useful against DNS rebinding attacks.\n\n- Run `api/main.py`. There is also an example lightAPI.service file you can copy to `/etc/systemd/system/` (after changing the paths) and run `sudo systemctl enable lightAPI` to have the API continuously run for you!\n\n- If you'd like to have alarm support, run `alarm/main.py`. The only endpoints are `/set//////` and `/stop/` and settings are read as documented above.\n\n- To use any module, you can either call the corresponding API endpoints through a browser or just run `main.py` under their folder.\n\n- In order to use the Tasker profiles, you must have purchased all of Tasker, AutoWear, and AutoAlarm. Afterwards,\n - Import all tasks inside the `tasker/tasks` directory.\n - Import all profiles inside the `tasker/profiles` directory.\n - Open each task and change `raspberrypi` to the IP address of your Raspberry Pi.\n\nOh, it also runs on Docker. You could create a config.json file and run:\n\n```\ndocker build -t lightapi .\ndocker run -p 5000:5000 lightapi # add \"--restart always\" to continuously restart and \"-p 54433:54433\" if you have a yeelight bulb\n```\n\n## Endpoints\n\n- http://my.ip.goes.here:5000/camera/\n\n Triggers a camera alarm, making the light full brightness on white color and sending an e-mail if configured. Your camera system should be pointing here.\n\n - light: The light to turn on.\n\n- http://my.ip.goes.here:5000/camera/off/\n\n Disarms the camera module. If the given password is incorrect, returns with a naive 404.\n\n - password: The password needed, before it's SHA512-hashed.\n\n- http://my.ip.goes.here:5000/camera/on\n\n Arms the camera module.\n\n- http://my.ip.goes.here:5000/colors\n\n Starts color rotation, for all lights.\n\n- http://my.ip.goes.here:5000/colors/\n\n Starts color rotation for all lights, with a pre-defined number of seconds between full color changes.\n\n - seconds: The number of seconds between color changes.\n\n- http://my.ip.goes.here:5000/rotate/stop\n\n Stops all color rotation, for all lights.\n\n- http://my.ip.goes.here:5000/\n\n Shows the status of all devices.\n\n- http://my.ip.goes.here:5000//set////\n\n You can use this to manually set a light color. You can take the values returned from the main page and put them here.\n\n - light: The light to be affected.\n - hue: The hue value for the light, between 1-65535.\n - saturation: The saturation value for the light, between 1-65535.\n - brightness: The brightness value for the light, between 1-65535.\n - kelvin: The kelvin value for the light, betweem 2500-9000.\n\n- http://my.ip.goes.here:5000//off/\n\n A simple timer. The light will slowly dim down and turn off afterwards. Keep in mind that I intentionally add 5% to the given value because of some race conditions.\n\n - light: The light to be affected.\n - seconds: The number of seconds after which the light will shut off.\n\n- http://my.ip.goes.here:5000//random\n\n Sets the light to a random color.\n\n - light: The light to be affected.\n\n- http://my.ip.goes.here:5000//random/\n\n Sets the light to a random color, with a provided brightness.\n\n - light: The light to be affected.\n - brightness: The brightness requested, in percent.\n\n- http://my.ip.goes.here:5000//blink\n\n Blinks the light three times, rapidly dimming and re-brightening the light over the span of a second or two.\n\n - light: The light to be affected.\n\n- http://my.ip.goes.here:5000//blink/\n\n Blinks the light a given number of times, rapidly dimming and re-brightening the light over the span of a second or two.\n\n - light: The light to be affected.\n - count: The number of times to blink the light.\n\n- http://my.ip.goes.here:5000//blink//\n\n Blinks the light a given number of times, rapidly dimming and re-brightening the light over the span of a second or two. Also allows you to specify the brightness level to dim it to.\n\n - light: The light to be affected.\n - count: The number of times to blink the light.\n - brightness: The brightness to dim down to, in percent.\n\n- http://my.ip.goes.here:5000//blink///\n\n Blinks the light in a specific color, a given number of times. If multiple lights are present in a group, they will all blink sequentially.\n\n - light: The light to be affected.\n - color: The color to blink it in.\n - count: The number of times to blink it.\n - brightness: The brightness value, in percent.\n\n- http://my.ip.goes.here:5000//\n\n Sets a light to a specific color.\n\n - light: The light to be affected.\n - color: The color to set it to.\n\n- http://my.ip.goes.here:5000///\n\n Sets a light to a specific color with a specific brightness level.\n\n - light: The light to be affected.\n - color: The color to set it to.\n - brightness: The brightness level in percent.\n\n- http://my.ip.goes.here:5000/////\n\n Sets a light to a specific color with a specific brightness level, dimming or brightening it over time.\n\n - light: The light to be affected.\n - color: The color to set it to.\n - brightness: The brightness level in percent.\n - seconds: The number of seconds to change the brightness over.\n - otherBrightness: The next brightness level in percent.\n\n- http://my.ip.goes.here:5000//on\n\n Turns the light on.\n\n - light: The light to turn on.\n\n- http://my.ip.goes.here:5000//brightness/\n\n Sets a light to a specific brightness. You can also use + or - before your number to increase or decrease the brightness by that amount. For example, setting brightness to +10 will brighten the light by 10%.\n\n - light: The light to be affected.\n - brightness: The brightness value in percent.\n\n- http://my.ip.goes.here:5000//off\n\n Turns the light off.\n\n - light: The light to turn off.\n\n- http://my.ip.goes.here:5000//toggle\n\n Toggles the light.\n\n - light: The light to toggle.\n\n- http://my.ip.goes.here:5000/toggle\n\n Toggles all lights. If a majority of the lights are on, it will turn all lights off, and vice versa.\n\n- http://my.ip.goes.here:5000/toggle/\n\n Toggles all lights. If a majority of the lights are on, it will turn all lights off, and vice versa.\n\n - color: The color to set lights to, if turning them on\n\n- http://my.ip.goes.here:5000//toggle/\n\n Toggles the light.\n\n - light: The light to toggle.\n - color: The color to change it to\n\n- http://my.ip.goes.here:5000//rotate/\n\n Starts fading the light to different colors.\n\n - light: The light to be affected.\n - seconds: The number of seconds between full color changes.\n\n- http://my.ip.goes.here:5000//rotate/stop\n\n Stops color rotation for a given light.\n\n - light: The light to be affected.\n\n\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",11657222510,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_46":115,"_116":90,"_117":29,"_118":52,"_53":119,"_120":121,"_122":105,"_123":115,"_124":62,"_125":17},"content_type","creator",5374336,"full_size",522116001,"id",215981244,"images",[97],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":114},"architecture","arm64","digest","sha256:f7065d259f9e49afcfce39d7b281e774267ea67d822e11689010274179aa3324","features","","last_pulled","2026-09-22T02:59:21.904439748Z","last_pushed","2022-06-12T19:15:48Z","os","linux","os_features","os_version","size","variant","v8","2022-06-12T19:15:47.145197Z","last_updater","last_updater_username","media_type","latest","repository",6660886,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":137,"_144":145,"_133":154,"_155":11},{"_36":138,"_38":139,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":140,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":141,"_75":11,"_76":143,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":142},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_146":60,"_147":-5,"_148":-5,"_149":150},"count","next","previous","results",[151],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":152,"_46":115,"_116":90,"_117":29,"_118":52,"_53":119,"_120":121,"_122":105,"_123":115,"_124":62,"_125":17},[153],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":114},[],"canDeleteTags","actionData","errors"]

johnthenerd/lightapi

Tags for johnthenerd/lightapi