github.com/ckxng/wakeup@v0.0.0-20190105202853-90356a5f5a15/README.md (about) 1 Wakeup 2 ====== 3 This tool is designed to be used by families with small children, or by adults 4 who need a little more structure in their wakeup routine. The application 5 runs in a cross-platform CEF window and displays the current time as well as 6 the weather for the day. It is intended to be run 24/7 as a full-screen alarm 7 clock. At the time indicated in the configuration file, a wakeup routine will 8 begin. This routine is a sequence of songs, each one pertaining to some 9 pre-defined aspect of the morning routine. An icon will flash on-screen 10 indicating what the associated action is (get up, brush teeth, eat breakfast). 11 12 Status 13 ------ 14 This software is ABANDONED and no further improvements will be made. 15 16 This project is barely functional and is missing some key code for OSX and 17 Linux support. 18 19 Configuration 20 ------------- 21 There are six default actions programmed into this application. 22 - wakeup-rise 23 - wakeup-dress 24 - wakeup-breakfast 25 - wakeup-teeth 26 - wakeup-backpack 27 - wakeup-leave 28 29 The schedule can be adjusted by creating a file called 30 ./Release/assets/config/cron_schedule.js. There is an example file called 31 cron_schedule.js.example in that same folder. 32 33 Audio files must be added to the ./Release/assets/audio/ folder using the 34 filename "ACTION.ogg" (for example: wakeup-rise.ogg). There is a sample file 35 called sample.ogg in that same folder. The audio file will loop. 36 37 Image files must be added to the ./Release/assets/images/ folder using the 38 filename "ACTION.png" (for example: wakeup-rise.png). There is are sample 39 images for each of the built-in actions in that same folder. 40 41 Platforms 42 --------- 43 The primary target for Wakeup is a RaspberryPi running Raspbian ARMv6 with a 44 small (3.2inch) screen. However, to whatever extent it is possible, 45 compatibility will be maintained with the then-current Linux x86 and x86_64, 46 Windows x86_64, and OS X x86_64 running the most recent stable version of Go. 47 48 49 Getting started on Windows 50 -------------------------- 51 1. Install Go 32-bit. CEF 64-bit binaries are still experimental and 52 were not tested. 53 54 2. Install mingw 32-bit and add C:\MinGW\bin to PATH. You can install mingw 55 using [mingw-get-setup.exe] 56 (http://sourceforge.net/projects/mingw/files/Installer/). 57 Select packages to install: "mingw-developer-toolkit", 58 "mingw32-base", "msys-base". CEF2go was tested and works fine 59 with GCC 4.8.2. You can check gcc version with "gcc --version". 60 61 3. Download CEF 3 branch 1750 revision 1590 binaries: 62 [cef_binary_3.1750.1590_windows32.7z] 63 (https://github.com/CzarekTomczak/cef2go/releases/download/cef3-b1750-r1590/cef_binary_3.1750.1590_windows32.7z) 64 Copy Release/* to cef2go/Release 65 Copy Resources/* to cef2go/Release 66 67 4. Run build.bat (or "build.bat noconsole" to get rid of the console 68 window when running the final executable) 69 70 71 Getting started on Linux 72 ------------------------ 73 1. These instructions work fine with Ubuntu 12.04 64-bit. 74 On Ubuntu 13/14 libudev.so.0 is missing and it is required to 75 create a symbolic link to libudev.so.1. For example on 76 Ubuntu 14.04 64-bit run this command: 77 `cd /lib/x86_64-linux-gnu/ && sudo ln -sf libudev.so.1 libudev.so.0`. 78 79 2. Install CEF dependencies: 80 `sudo apt-get install build-essential libgtk2.0-dev libgtkglext1-dev` 81 82 3. Download CEF 3 branch 1750 revision 1604 binaries: 83 [cef_binary_notcmalloc_3.1750.1604_linux64.zip] 84 (https://github.com/CzarekTomczak/cef2go/releases/download/cef3-b1750-r1604/cef_binary_notcmalloc_3.1750.1604_linux64.zip) 85 Copy Release/* to cef2go/Release 86 87 4. Run "make" command. 88 89 90 Getting started on Mac OS X 91 --------------------------- 92 1. These instructions work fine with OS X 10.8 Mountain Lion. 93 May also work with other versions, but were not tested. 94 95 2. Install Go 32-bit. Tested with Go 1.2-386 for OSX 10.8. 96 CEF binaries for OSX 64-bit are still experimental, that's 97 why we're using 32-bit. Though you can try building with 98 CEF 64-bit, download binaries from [cefbuilds.com] 99 (http://cefbuilds.com). 100 101 3. Install command line tools (make is required) from: 102 https://developer.apple.com/downloads/ 103 (In my case command line tools for Mountain Lion from September 2013) 104 105 4. Install XCode (gcc that comes with XCode is required). 106 Use the link above. In my case it was XCode 4.6.3 from June 2013. 107 108 5. Download CEF 3 branch 1750 revision 1625 binaries for 32-bit: 109 [releases/tag/v0.12] 110 (https://github.com/CzarekTomczak/cef2go/releases/tag/v0.12) 111 Copy the cef2go.app directory to cef2go/Release. 112 113 6. Run "make" command. 114 115 Copying 116 ------- 117 Wakeup is licensed under the 2-CLAUSE BSD LICENSE. See LICENSE for details. 118 119 CEF2go is licensed under the 3-CLAUSE BSD LICENSE. See cef2go.LICENSE for 120 details. 121 122 Chromium Embedded Framework is licensed under the 3-CLAUSE BSD LICENSE. 123 See https://code.google.com/p/chromiumembedded/ for details. 124 125 AngularJS is licensed under the MIT license. See angularjs.LICENSE for details. 126 127 Bootstrap is licensed under the MIT license. See bootstrap.LICENSE for details. 128 129 Date.Format is licensed under the MIT license. See 130 http://blog.stevenlevithan.com/code for details. 131 132 Html5shiv is licensed under the MIT and GPL2 license. See html5shiv.LICENSE.md 133 for details. 134 135 jQuery is licensed under the MIT license. See http://jquery.org/license/ for 136 details. 137 138 Respond.js is licensed under the MIT license. See respondjs.LICENSE for 139 details. 140 141 Cron for Javascript is licensed under the GPL3 license. See 142 http://www.gnu.org/licenses/ for details. 143 144 Sample audio files from Joseph SARDIN are royalty-free. See 145 http://www.bigsoundbank.com/sound-0172-reveil-semi-mecanique.html for details. 146 147 Sample images files are in the Public Domain. See 148 https://openclipart.org/share for details.