This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
installation [2013/10/16 11:31] curlymo |
installation [2016/02/16 06:27] (current) yablacky Added hints on how to build pilight on windows. |
||
---|---|---|---|
Line 5: | Line 5: | ||
//Linux, FreeBSD and OSX// | //Linux, FreeBSD and OSX// | ||
- | Before you install ''pilight'', make sure you have ''gcc'' installed. On some distributions you can also install all compilation tools at once by installing ''build-essential''. The installation of these programs differ from distribution to distribution. Please refer to their instructions on how to do this. | + | Before you install ''pilight'', make sure you have ''gcc'', ''cmake'' and ''dialog'' installed. On some distributions you can also install all compilation tools at once by installing ''build-essential''. The installation of these programs differ from distribution to distribution. Please refer to their instructions on how to do this. |
//Windows// | //Windows// | ||
- | The prerequisites for compiling for Windows are includes in the git package. | + | The prerequisites for compiling for Windows are included in the git package. You have to provide a framework like ''Visual Studio'' and have to install ''CMake'' and ''grep''. For ''grep'' you might pick "Complete package, except sources" from [[http://gnuwin32.sourceforge.net/packages/grep.htm|here]]. It's recommended to install this grep as an adminstrator and then by hand look for grep's bin-path and add this to the systemwide PATH environment variable (this grep installer does //not// do this for you). For ''CMake'' look [[https://cmake.org/download/|here]]. |
- | Connecting the Hardware | + | If you have all the tools together, clone a ''pilight'' git repository to your local disk, open a windows ''command line prompt'' and change directory to where your local ''pilight'' repository remains. Then run <code>CMake .</code> which will create all your framework specific "makefiles" needed to compile and build ''pilight''. |
- | Make sure you have a supported receiver. Currently only one type has been successfully tested. This one is called //433MHz Superheterodyne 3400 RF Transmitter and Receiver link kit// and can be bought from Ebay. | + | //Connecting the Hardware// |
- | In order to fully use ''pilight'' you need to have one of the supported hardware senders and receiver connected and preferable build an [[electronics|active low-pass filter]]. The low-pass filter is meant to filter all noise inevitable received by these receivers. Currently ''pilight'' can run in two hardware modes. Please refer to the [[settings|settings.json]] description on how to use one of these modes. | + | Make sure you have a supported receiver. Currently only one type has been proven successful. This one is called //433MHz Superheterodyne 3400 RF Transmitter and Receiver link kit// and can be bought from Ebay. |
+ | |||
+ | In order to fully use ''pilight'' you need to have one of the supported hardware senders and receiver connected, and preferably also a [[low-pass filter]]. The low-pass filter is meant to filter all noise inevitably received by these receivers. | ||
+ | Currently ''pilight'' can run in three hardware modes. Please refer to the [[config|config.json]] description on how to use one of these modes. | ||
//Module// | //Module// | ||
Line 31: | Line 34: | ||
In this mode, ''pilight'' will directly use the gpio pins. This hardware mode is advised when you are using a low-pass filter. | In this mode, ''pilight'' will directly use the gpio pins. This hardware mode is advised when you are using a low-pass filter. | ||
- | * Just connect the receiver to BCM pin 18 (wiringPi 1) and the sender to BCM pin 17. | + | * Just connect the receiver to BCM pin 18 (wiringX 1) and the sender to BCM pin 17. |
+ | * If using a filter, connect the receiver to the data-input on the filter instead, and connect the data-output pin to pin 18 | ||
- | Compilation and Installation | + | //None// |
+ | This is a blank mode, where ''pilight'' does not use the GPIO at all, so it has no sending or receiving capabilities. Use this mode when running ''pilight'' on a computer that does not have GPIO, such as a NAS. | ||
- | Please follow these steps carefully to install ''pilight'': | + | //Compilation and Installation// |
+ | |||
+ | To use the precompiled deb package, follow the instructions [[http://apt.pilight.org/INSTALL.md|here]]. This is the recommended way if you want to install the latest stable version. | ||
+ | |||
+ | If you want to use the latest development version you need to either compile and install ''pilight'' manually, or use the nightlies that are prepared for installation every night (see [[http://www.pilight.org/nightly/|here]] for more information). Use these commands to compile and install pilight manually | ||
<code> | <code> | ||
cd ~ | cd ~ | ||
- | git clone --depth 5 https://github.com/pilight/pilight.git | + | git clone --depth 5 -b development https://github.com/pilight/pilight.git |
cd pilight | cd pilight | ||
- | make | + | chmod +x setup.sh |
- | make install | + | ./setup.sh |
- | ldconfig | + | |
</code> | </code> | ||
''pilight'' is now installed and can be used by running ''service pilight start''. This will run | ''pilight'' is now installed and can be used by running ''service pilight start''. This will run | ||
- | ''pilight'' with a default configuration. This allows basic sending en receiving. | + | ''pilight'' with a default configuration. This allows basic sending and receiving. |
+ | |||
+ | //Configuring// | ||
- | Configuring | + | To change any of the default settings of ''pilight'' modifications can be made in the settings section of the [[config|config.json]] file. It is possible to predefine specific locations and their respective devices in the [[config|config.json]]. Please refer to the wiki page for further explanations. |
- | To change any of the default settings of ''pilight'' alterations can be made in the settings.json file. To predefine specific locations and their respective devices a config.json file can be created. Please refer to both wiki pages for further explanations. |