This is an old revision of the document!
Linux, FreeBSD and OSX
Before you install
pilight, make sure you have
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.
The prerequisites for compiling for Windows are included in the git package.
Connecting the Hardware
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.
pilight can run in three hardware modes. Please refer to the config.json description on how to use one of these modes.
In this mode,
pilight will use a lirc kernel module to send a receive codes. This hardware mode is advised when you are not using a low-pass filter.
modprobe lirc_rpi gpio_in_pin=18 gpio_out_pin=17
In this mode,
pilight will directly use the gpio pins. This hardware mode is advised when you are using a low-pass filter.
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.
Compilation and Installation
To use the precompiled deb package, follow the instructions 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 here for more information). Use these commands to compile and install pilight manually
cd ~ git clone --depth 5 -b development https://github.com/pilight/pilight.git cd pilight chmod +x setup.sh ./setup.sh
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 and receiving.
To change any of the default settings of
pilight modifications can be made in the settings section of the config.json file. It is possible to predefine specific locations and their respective devices in the config.json. Please refer to the wiki page for further explanations.