Tweet
After reading this tutorial, you are able to make Siri and Home app:
- monitor any kind of sensors, which is listed by Apple.
- control any kind of devices, which is listed by Apple.
System Architecture
Hardware
- Raspberry Pi 3 Model B
- PHPoC Blue (+ USB WLAN) or PHPoC Black (+ Ethernet cable)
- Any sensors/devices
- Jumper wires
How To
Step 1: installing homebridge on Raspberry Pi
Follow this instruction
Step 2: Installing PHPoC Plugin on Raspberry Pi
PHPoC plugin does two main tasks:
- Periodically making HTTP request to PHPoC board to get states of sensors/devices and updating these states to Home App.
- On-demand making HTTP request to PHPoC board to control/monitorsensors/devices when there is request from Siri or Home app.
To install this plugin, type the following command:
Code:
sudo npm install -g homebridge-phpoc
Step 3: Writing Config File on Raspberry Pi
Config file mainly defines which devices and their characteristics is shown on Home app.
Refer to the sample config.json file below
Code:
{
"bridge":{
"name":"Homebridge",
"username":"CC:22:3D:E3:CE:31",
"port":51826,
"pin":"031-45-154"
},
"accessories":[
{
"accessory": "PHPoC",
"name": "Living Room Lamp",
"service": "Lightbulb",
"characteristics": [
"On"
],
"url": "http://192.168.0.189/lightbulb_livingroom.php",
"update_interval": 1000100
},
{
"accessory": "PHPoC",
"name": "Bedrom Room Lamp",
"service": "Lightbulb",
"characteristics": [
"On",
"Brightness"
],
"url": "http://192.168.0.189/lightbulb_bedroom.php",
"update_interval": 1000200
},
{
"accessory": "PHPoC",
"name": "Carbon Monoxide",
"service": "Carbon Monoxide Sensor",
"characteristics": [
"Carbon Monoxide Level",
"Carbon Monoxide Detected",
"Carbon Monoxide Peak Level"
],
"url": "http://192.168.0.189/carbon.php",
"update_interval": 1000
},
{
"accessory": "PHPoC",
"name": "temperature",
"service": "Temperature Sensor",
"characteristics": "Current Temperature",
"url": "http://192.168.0.189/temperature.php",
"update_interval": 1050
}
]
}
We just need to take a look at accessories part. Here I defines four accessories (also called devices):
- Living Room Lamp: Allow to control and monitor on/off state.
- Bedroom Lamp: Allow to control and monitor on/off state and brightness.
- Carbon Monoxide Sensor: Allow to detect the Carbon Monoxide and monitor Carbon Monoxide level and Carbon Monoxide peek level.
- Temperature Sensor: Allow to monitor temperature value from temperature sensor.
Structure of each accessories is the same. They has the following fields:
- "accessory": Value is "PHPoC" because it uses homebridge-phpoc plugin installed above.
- "name": This will be displayed in Home App and is Keyword to ask Siri. No rule for this field but I recommend to use the name of sensors/devices
- "service": device type. It MUST be the one of Apple-defined services, which specified in HomeKit Accessory Protocol Specification
- "characteristics": characteristics of sensors/devices. It MUST be some of Apple-defined characteristics, which specified in HomeKit Accessory Protocol Specification
- "url": the link to PHPoC devices, which reads value from sensors or take control of devices.
- "update_interval": Interval of updating characteristics of accessories to Home App. The unit is millisecond.
Step 4: Connecting PHPoC Board to Sensors/Devices and Writing PHPoC Code
After connecting PHPoC board to sensors/devices, We need to write code for PHPoC board to handle HTTP request from homebridge-phpoc plugin.
In case of controlling, PHPoC code does:
- Get the controlling information from HTTP request and then control devices
- Read states of sensors/devices and then send back to homebridge-phpoc plugin.
In case of monitoring, PHPoC code does:
- Read states of sensors/devices and then send back to homebridge-phpoc plugin.
Note: when sending back states of sensors/devices, data MUST be in json format. Keys MUST be characteristics name without blank spaces. For example, if characteristic is "Carbon Monoxide Level", json key MUST be "CarbonMonoxideLevel".
Example codes:
- Carbon Monoxide Sensor (carbon.php): only monitoring
- Temperature Sensor (temperature.php): only monitoring
- Lightbulb (lightbulb_bedroom.php and .php): monitoring and controlling
PHP Code:
<?php
/* example value. write the code to read the read value from sensor here */
$is_detected = 1;
$level = 26;
$peak_level = 32;
?>
{
"CarbonMonoxideDetected" : <?php echo $is_detected ?>,
"CarbonMonoxidePeakLevel": <?php echo $peak_level ?>,
"CarbonMonoxideLevel": <?php echo $level ?>
}
temperature.php
PHP Code:
<?php
$temp = 31; // change code to read the real temperature value from sensor here
?>
{
"CurrentTemperature": <?php echo $temp?>
}
lightbulb_bedroom.php
PHP Code:
<?php
include_once "/lib/sd_340.php";
define("OUT_PIN", 31);
uio_setup(0, OUT_PIN, "out");
if(($led0 = _GET("On")))
{
if($led0 === "true")
uio_out(0, OUT_PIN, LOW);
else
uio_out(0, OUT_PIN, HIGH);
}
if(uio_in(0, OUT_PIN) == LOW)
$on = 1;
else
$on = 0;
/* do Similar for brightness */
$brightness = 80; // example value
?>
{
"On" : <?php echo $on ?>,
"Brightness" : <?php echo $brightness ?>
}
lightbulb_livingroom.php
PHP Code:
<?php
include_once "/lib/sd_340.php";
define("OUT_PIN", 30);
uio_setup(0, OUT_PIN, "out");
if(($led0 = _GET("On")))
{
if($led0 === "true")
uio_out(0, OUT_PIN, LOW);
else
uio_out(0, OUT_PIN, HIGH);
}
if(uio_in(0, OUT_PIN) == LOW)
echo '{"On" : true}';
else
echo '{"On" : false}';
?>
Step 5: Setting Home app your iPhone, iPad
Refer to https://support.apple.com/en-us/HT204893
Step 6: Controlling and Monitoring via Siri or Home app
