diff --git a/.gitignore b/.gitignore index 16568bf2279706b6c787998a46aa45169a18e0f5..82a584dc4bc3fb94377d8251b253f87a9029aafc 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ skyglow.log moon?* +README.html diff --git a/README.md b/README.md index 00006d9e783fe580f7a8d265c2a26445d767d272..62ea9b5e794f144d407442b2649b17241ab3e2da 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,26 @@ Python program written for the ecoLux project in the ecoTron to periodically set This was tested and run on a Raspberry Pi connected via DMX to the LED's in the ecounits. OLA (Open Light Architecture Framework) is used to write to the DMX-Bus. +##Usage## + +```console + skyglow.py +``` +will look for a file called **moon** in its directory, to extract the intensities of the moon for the current time. Alternatively you can also pass a file as an argument. +```console + skyglow.py /path/to/moon/file +``` + +If everything worked, a line should be added to skyglow.log: +``` + #date moon[mlx] moon[dmx] lightpollution[mlx] + 2020-07-21 15:00:00 0.05 11 [15, 54, 4, 19, 0, 1, 5, 0, 40, 12, 123, 123] +``` +The indices of the list containing the lightpollution valus refer to the number of the ecounits. + +##Setup## -##Building OLA## +###Building OLA### In order to get a recent version with python support we need to build OLA. See [this](https://www.openlighting.org/ola/tutorials/ola-on-raspberry-pi/) and [this](https://www.openlighting.org/ola/linuxinstall/#Debian_Ubuntu) for details. @@ -44,32 +62,14 @@ Run the daemon: ```console olad ``` - - -##Usage## - -It will look for a file called **moon** in its directory, to read the intensities of the moon. -```console - skyglow.py -``` - Alternatively you can pass a different file as an argument. -```console - skyglow.py /path/to/moon/file -``` +###new moonfile### If you acquire a new moonfile, make sure to replace all occurrences of **24:00** to **00:00**. Otherwise python will throw an error. ```console sed -i 's/24:00/00:00/g' moonfile ``` - -If everything worked, a line should be added to skyglow.log: -``` - #date moon[mlx] moon[dmx] lightpollution[mlx] - 2020-07-21 15:00:00 0.05 11 [15, 54, 4, 19, 0, 1, 5, 0, 40, 12, 123, 123] -``` -The indices of the list containing the lightpollution valus refer to the number of the ecounits. - -Now set up a cronjob to check for new values every minute. Run +###cron### +Set up a cronjob to check for new values every minute. Run ``` crontab -e ``` @@ -82,4 +82,4 @@ and insert Check the `skyglow.log` to see if it gets updated every minute. ``` watch -n1 tail skyglow.log -``` \ No newline at end of file +```