Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/markuskooche/lightswitch
A light switch with Apple HomeKit support.
https://github.com/markuskooche/lightswitch
apple homekit homekit-device lightswitch
Last synced: about 1 month ago
JSON representation
A light switch with Apple HomeKit support.
- Host: GitHub
- URL: https://github.com/markuskooche/lightswitch
- Owner: markuskooche
- Created: 2021-03-30T15:49:27.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-04-09T21:46:26.000Z (over 3 years ago)
- Last Synced: 2023-06-14T20:58:01.011Z (over 1 year ago)
- Topics: apple, homekit, homekit-device, lightswitch
- Language: Python
- Homepage:
- Size: 442 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# LightSwitch
## Table of Contents
1. Installation
1. [Install Node.JS & Homebridge on a Raspberry PI](#install-node-and-homebridge)
2. [How to flash an ESP8266](#flash-a-esp)
3. [Preparing Homebridge On RaspberryPi](#preparing-homebridge-on-raspberrypi)
4. [Setting Up MQTT Server On RaspberryPi](#setting-up-mqtt-server-on-raspberrypi)
5. [Technologies](#technologies)
5. [Collaborator](#collaborator)
2. ...
Please create a [config.json](./controller/boot/config.json) file
```
{
"credentials": {
"ssid": "YOUR_SSID",
"password": "YOUR_PASSWORD"
}
}
```
## Flash an ESP8266
1. Please make sure your controller is connected with a DATA CABLE.
2. Open the terminal and navigate into this directory
3. Run the init.sh script to install al dependencies and flash the controller.
```
#!/usr/bin/env bash
brew install --build-from-source [email protected]
xcode-select --install
brew install picocom
brew install pip3
pip3 install esptool
pip3 install adafruit-ampy
binary='binary/esp8266-[0-9]*-v*.bin'
port='/dev/cu.usbserial-1420'
esptool.py --port $port erase_flash
esptool.py --port $port --baud 460800 write_flash --flash_size=detect 0 $binary
```
## Install Node.JS & Homebridge on a Raspberry PI
1. Setup the Repository
```
curl -sL https://deb.nodesource.com/setup_14.16.0 | sudo bash -
````
2. Install node.js additional packages
```
sudo apt install -y nodejs gcc g++ make python net-tools
```
3. Upgrade node.js to the newest LTS version
```
wget http://nodejs.org/dist/v14.16.0/node-v14.16.0-linux-armv7l.tar.xz
```
4. Unpack the node.js LTS version
```
tar -xvf node-v14.16.0-linux-armv7l.tar.xz
```
5. Navigate into the unpacked folder
```
cd node-v14.16.0-linux-armv7l.tar.xz
````
6. Transfer the folder and restart your device
```
sudo cp -R * /usr/local/
shutdown -r now
```
7. Install Homebridge and Homebridge UI
```
sudo npm install -g --unsafe-perm homebridge homebridge-config-ui-x
```
8. Setup Homebridge as a service that will start on boot
```
sudo hb-service install --user homebridge
```
9. Make sure that you have all npm packages are update to date
```
npm install -g npm-check-updates
```
10. Restart your device
```
shutdown -r now
```
Now homebridge is runing on port 8581
You can get your IP Adress with this command
```
hostname -I
```
## Preparing Homebridge On RaspberryPi
1. Execute [homebridge/install.sh](homebridge/install.sh) with
````
./homebridge/install.sh
````
2. Add the contents of [homebridge-config.json](homebridge/install.sh) to the accessories array in the homebridge config.json file at [/var/lib/homebridge/config.json](/var/lib/homebridge/config.json)
3. Restart homebridge with command
````
systemctl restart homebridge.service
````
## Setting Up MQTT Server On RaspberryPi
1. Execute [mqtt/install.sh](mqtt/install.sh) with
````
sudo ./mqtt/install.sh
````
## Technologies
A list of technologies used within the project:
* [Node.js](https://nodejs.org): Version 14.16.0
* [Homebridge](https://homebridge.io): Version 1.3.4
## Collaborator
* [Valentin Falke](https://github.com/vale700)
* [Markus Koch](https://github.com/markuskooche)