Permalink
Browse files

Add instructions to README.md

  • Loading branch information...
Gerzer committed Jul 27, 2017
1 parent 5bbee1a commit 07c3e45b92487eb9f8abe0acd5c35c5d9fcf180a
Showing with 80 additions and 1 deletion.
  1. +1 −1 PiBakery Recipe.xml
  2. +79 −0 README.md
@@ -1 +1 @@
<xml xmlns="http://www.w3.org/1999/xhtml"><block type="onfirstboot" id="onfirstboot" x="0" y="0"><next><block type="wifisetup" id="H{hAO;}Hjy:.~zgtk7p?"><field name="1">network-name</field><field name="2">network-password</field><field name="3">WPA/WPA2</field><next><block type="runcommand" id="mpbnc/_~[kAi2tq=3#k|"><field name="1">mkdir /home/pi/PiBeacon/</field><field name="2">pi</field><next><block type="downloadfile" id="zV1U/;bKxkX}0.FV;GR~"><field name="1">https://github.com/Gerzer/PiBeacon/raw/master/Beacon.py</field><field name="2">/home/pi/PiBeacon/Beacon.py</field><next><block type="runcommand" id="LznIG_^xMl!Vzj]7_s5d"><field name="1">echo -n "00 00" &gt; /home/pi/PiBeacon/Major.txt</field><field name="2">pi</field><next><block type="runcommand" id="5vYc4~5sN,Gh|O0~G/h?"><field name="1">echo -n "00 00" &gt; /home/pi/PiBeacon/Minor.txt</field><field name="2">pi</field><next><block type="bootbehaviour" id="en2MN|{i(O:u(t.0`SD@"><field name="1">Console logged in</field><next><block type="reboot" id="l+C|{P)*oHvG_7ib94g;"></block></next></block></next></block></next></block></next></block></next></block></next></block></next></block><block type="onboot" id="idO]|M@E+;eP2Md0)Gc4" x="0" y="456"><next><block type="runpython" id="|SBiMN2FP|Tzvjf,7F6k"><field name="1">/home/pi/PiBeacon/Beacon.py</field><field name="2">root</field></block></next></block></xml>
<xml xmlns="http://www.w3.org/1999/xhtml"><block type="onfirstboot" id="onfirstboot" x="0" y="0"><next><block type="wifisetup" id="H{hAO;}Hjy:.~zgtk7p?"><field name="1">network-name</field><field name="2">network-password</field><field name="3">WPA/WPA2</field><next><block type="sethostname" id="kv5@ihl@JSKZs.^2M`vL"><field name="1">pibeacon</field><next><block type="runcommand" id="mpbnc/_~[kAi2tq=3#k|"><field name="1">mkdir /home/pi/PiBeacon/</field><field name="2">pi</field><next><block type="downloadfile" id="zV1U/;bKxkX}0.FV;GR~"><field name="1">https://github.com/Gerzer/PiBeacon/raw/master/Beacon.py</field><field name="2">/home/pi/PiBeacon/Beacon.py</field><next><block type="runcommand" id="LznIG_^xMl!Vzj]7_s5d"><field name="1">echo -n "00 00" &gt; /home/pi/PiBeacon/Major.txt</field><field name="2">pi</field><next><block type="runcommand" id="5vYc4~5sN,Gh|O0~G/h?"><field name="1">echo -n "00 00" &gt; /home/pi/PiBeacon/Minor.txt</field><field name="2">pi</field><next><block type="bootbehaviour" id="en2MN|{i(O:u(t.0`SD@"><field name="1">Console logged in</field><next><block type="reboot" id="l+C|{P)*oHvG_7ib94g;"></block></next></block></next></block></next></block></next></block></next></block></next></block></next></block></next></block><block type="onboot" id="idO]|M@E+;eP2Md0)Gc4" x="0" y="482"><next><block type="runpython" id="|SBiMN2FP|Tzvjf,7F6k"><field name="1">/home/pi/PiBeacon/Beacon.py</field><field name="2">root</field></block></next></block></xml>
@@ -1,2 +1,81 @@
# PiBeacon
Low-cost iBeacon using Raspberry Pi
## Components
All components are required unless stated otherwise.
### Hardware
- Raspberry Pi Zero W
- Raspberry Pi Zero Official Case *(Optional)*
- microUSB cable
- 4 GB or larger microSD card
- microSD to SD card adapter *(Required unless you're able to write to a microSD card directly from your computer)*
- Computer capable of writing to an SD card
- iPhone, iPad, or iPod touch *(Any one device from the sub-list required)*
- iPhone 4s *(Support planned)*
- iPhone 5 *(Support planned)*
- iPhone 5s *(Partial support)*
- iPhone 5c *(Support planned)*
- iPhone 6 *(Partial support)*
- iPhone 6 Plus *(Partial support)*
- iPhone 6s
- iPhone 6s Plus
- iPhone 7
- iPhone 7 Plus
- iPhone SE
- iPad (3rd generation) *(Support planned)*
- iPad (4th generation) *(Support planned)*
- iPad (5th generation)
- iPad mini *(Support planned)*
- iPad mini 2 *(Partial support)*
- iPad mini 3 *(Partial support)*
- iPad mini 4 *(Partial support)*
- iPad Air *(Partial support)*
- iPad Air 2 *(Partial support)*
- 9.7-inch iPad Pro
- 10.5-inch iPad Pro
- 12.9-inch iPad Pro (1st generation)
- 12.9-inch iPad Pro (2nd generation)
- iPod touch (5th generation) *(Support planned)*
- iPod touch (6th generation) *(Partial support)*
### Software
The below list doesn't include the various components of the PiBeacon project itself.
- [PiBakery](http://www.pibakery.org)
- macOS or Windows *(Any one version from the sub-list required)*
- macOS Mavericks *(Partial support)*
- macOS Yosemite *(Partial support)*
- macOS El Captian *(Partial support)*
- macOS Sierra
- macOS High Sierra
- Windows Vista *(Partial support)*
- Windows 7 *(Partial support)*
- Windows 8 *(Partial support)*
- Windows 10 *(Partial support)*
- iOS *(Any one version from the sub-list required)*
- iOS 11
Support for older versions of iOS is under development.
## Instructions
1. Open PiBakery
2. Click "Import"
3. Navigate to "PiBakery Recipe.xml"
4. Replace "network-name" with your Wi-Fi network name
5. Configure Wi-Fi authentication
- WPA and WPA 2 networks
1. Replace "network-password" with your Wi-Fi network password
- WEP networks
1. Change "WPA/WPA2" to "WEP" from dropdown menu
2. Replace "network-password" with your Wi-Fi network password
- Open networks
1. Change "WPA/WPA2" to "Open (no password)" from dropdown menu
6. Replace "pibeacon" with a custom hostname *(Optional)*
7. Insert SD card
8. Click "Write"
9. Change "Raspbian Full" to "Raspbian Lite" from dropdown menu
10. Click "OK"
11. Click "Start Write"
12. When ready, eject SD card
13. Insert SD card into Raspberry Pi
14. Connect Raspberry Pi to power source
15. Install [iOS client app](https://github.com/Gerzer/PiBeacon-Client---mobile-edition)
16. In iOS app, tap "Add Beacon"
17. Follow in-app instructions to configure beacon

0 comments on commit 07c3e45

Please sign in to comment.