|
|
| (49 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| − | ...Back to [[Projects:]] | + | ...Back to [[Projects:]]<br> |
| − | | + | [[File:1.jpeg|600px]]<br> |
| − | [[File:trigBoardv7.jpg|600px]] | + | <span style="color:red">Looking for Rev4?</span> Go here [[TrigBoardV4]]<br> |
| − | | + | <span style="color:red">Looking for Rev7?</span> Go here [[TrigBoardV7]]<br> |
| − | The trigBoard is an IoT project that does one thing - it pushes you a notification triggered by a digital input. Well, it's much more than that, but this is the inspiration. I wanted to design a WiFi board that essentially sleeps most of its life, but when that door switch, flood sensor, motion sensor, etc.. gets triggered, I just want a notification immediately on my phone. And that's about it... a perfect IoT device in the background doing its job.
| + | = Latest Release Version 8 = |
| − | | + | All documentation for V8 is hosted at Read The Docs [https://trigboard-docs.readthedocs.io/en/latest/index.html# HERE] |
| − | = Latest Release Version 7 =
| |
| − | | |
| − | [[File:trigBoardv7overhead.jpg|600px]]
| |
| − | | |
| − | <span style="color:red">Looking for Rev4?</span> Go here [[TrigBoardV4]] | |
| − | | |
| − | * Simple IoT development board that was designed to trigger "Push Notifications" on a smart phone/tablet based on a trigger event.
| |
| − | * Unique low-power front-end to enable sub 1uA sleep current - uses a pulse to trigger wake-up, so even if door/window/etc is opened, the same ultra low currents can be maintained. Compare to standard pull-up/down resistor based digital input designs with significantly higher leakage current.
| |
| − | * The board will wake itself up once an hour to check the battery voltage - if running low, a push notification is sent to warn the user. This timer can be used to check other things as well - temperature changes, accelerometers, or other environmental sensors.
| |
| − | * Based on ESP8266 WiFi Module (ESP-12S) - all source code is available for download and developed in the popular Arduino IDE.
| |
| − | * Battery Input can be any Lithium Polymer 3.7V - standard micro JST connector jack is used (please double check polarity),any of [https://www.adafruit.com/category/574 these] would work nicely.
| |
| − | * Sensor input to trigger the "Wake Up" is a simple passive switch. Typically a standard magnetic door/window switch is used and the board can be configured to wake on the "opening" (Normally Closed) or "closure" (Normally Open) of the contact. Solder jumpers set this - Normally Closed is Default, so standard door/window switches wake the board up when opened.
| |
| − | * Auto-Reset circuitry built-in, so now with an FTDI USB-Serial Converter, just click "upload" and the board starts programming. Note that this was designed to work with this [[The_USB_to_Serial_Converter:]]
| |
| − | * Expansion pads broken out, so integration with custom projects is possible.
| |
| − | * Dimensions only 0.8" x 1.6 " (20.32mm x 40.64mm)
| |
| − | | |
| − | '''trigBoard mentions'''
| |
| − | | |
| − | * [https://hackaday.com/2018/11/13/low-energy-esp8266-based-board-sleeps-like-a-log-until-triggered/ Hackaday]
| |
| − | * [https://www.youtube.com/watch?v=usyaBK4z5CA Andreas Spiess]
| |
| − | * [https://blog.hackster.io/the-trigboard-is-a-low-power-iot-platform-designed-around-the-esp8266-fffa6e267019 Hackster.io]
| |
| − | * [https://blog.tindie.com/2018/09/trigboard-small-iot-platform/ The Tindie Blog]
| |
| − | | |
| − | | |
| − | [[File:trigBoardV7diagram.png|800px]]
| |
| − | | |
| − | == Purchase trigBoard ==
| |
| − | [[File:tindie-larges.png|link=https://www.tindie.com/stores/kdcircuits]]
| |
| − | | |
| − | == Out of the Box Setup ==
| |
| − | {{#evt:
| |
| − | service=youtube
| |
| − | |id=https://youtu.be/CdTLs8dbHYQ
| |
| − | |dimensions=560x315
| |
| − | }}
| |
| − | | |
| − | The setup for getting the trigBoard installed is very easy. The base firmware that comes loaded on the board is ready to work with PushSafer. This makes it so easy to get up and running with the trigBoard. I switched from Pushbullet on the V4 board due to reliability and compatibility issues. Push Safer also has more attractive billing options. Instead of a monthly fee, now you just pay for the amount of notifications you want... when they run out, you just buy more. Best part is that they're super cheap.
| |
| − | | |
| − | [[File:PushSafer.png|400px|link=https://www.pushsafer.com]]
| |
| − | | |
| − | '''Push Safer Setup'''
| |
| − | | |
| − | # Go here: https://www.pushsafer.com and register.
| |
| − | # Download the mobile app for iOS or Android, and sign in. You can also setup push notifications for your computers as well by installing the browser plugins. You may even like getting the desktop notifications better.
| |
| − | # Go back to dashboard and copy your private key
| |
| − | | |
| − | [[File:pushSaferKey.png|600px]]
| |
| − | | |
| − | Notable Push Safer Features:
| |
| − | * Ability to send test messages from the dashboard
| |
| − | * Can "Mute" devices by toggling the Status switch in the dashboard
| |
| − | * Guest Devices by just scanning a QR code, then can enable/disable them as needed. Like for home security, you could give to a family member while you're out on vacation.
| |
| − | * Great support and a lot of exciting development!
| |
| − | * There are many more useful features in there as well... feel free to experiment!
| |
| − | | |
| − | '''trigBoard Setup'''
| |
| − | | |
| − | : '''Battery'''
| |
| − | :: '''Battery Options''' - You will need a 3.7V Lithium Battery - fully charged will be 4.2V. The battery connects to the trigBoard using a standard micro-JST PH 2mm connector. Any of '''[https://www.adafruit.com/category/574 these from Adafruit]''' would work. I typically use a ~1000mAh battery on all my doors/windows... that yields very long battery life. I'm also experimenting with [https://www.ebay.com/itm/112677378893 these from eBay] '''<span style="color:red">CHECK POLARITY!</span>''' This can damage the board, so check the drawing above and also the + and - symbols on the board match your battery.
| |
| − | :: '''Charging''' - This version of the board does not have a charge port, so you might want to pick something like this up as well https://www.adafruit.com/product/1304
| |
| − | : '''Sensors'''
| |
| − | :: '''Dry Contact Switch''' - magnetic door/window sensors like [https://www.amazon.com/dp/B00LYCUSBY/ref=sxbs_sxwds-stvp_1?pf_rd_m=ATVPDKIKX0DER&pf_rd_p=3341940462&pd_rd_wg=Nbhph&pf_rd_r=0DBSJ3Q6TNF9BDV32CXG&pf_rd_s=desktop-sx-bottom-slot&pf_rd_t=301&pd_rd_i=B00LYCUSBY&pd_rd_w=98468&pf_rd_i=magnetic+door+sensor&pd_rd_r=83aa0c34-3901-4f4f-bf19-1fc2ae849c87&ie=UTF8&qid=1512593794&sr=1 these]
| |
| − | ::'''Connectors''' - They are "Micro JST" JST_2PIN-SMT-RA, I go with [https://www.amazon.com/gp/product/B0167X4D9M/ref=oh_aui_search_detailpage?ie=UTF8&psc=1 these]. It would be nice to find magnetic switches with the JST connectors already soldered on... Check [https://iotexpert.com/2018/01/18/jst-connector-crimping-insanity/ this] guide out on making your own cables.
| |
| − | ::'''Jumpers''' - By default, the board is configured to "Wake" when the contact opens. This is the normally closed mode of operation. If it is desired to wake on a closure of the contact, then see the diagram above and desolder the NC solder jumpers and cut them open with a knife (on this board, I made the jumpers with tiny traces) and solder across the NO jumpers (make sure they are closed). That default NC configuration was chosen because the magnetic door/window sensors are closed when the magnet is in proximity, so the trigBoard wakes up when the door/window is opened.
| |
| − | :'''<span style="color:red"> IMPORTANT NOTE ABOUT TIMER</span>''' - The trigBoard performs a calibration on the built-in timer on power-up. The sensor input must be closed when powered up, otherwise the 1hr timer will not be accurate. You basically just need to have the door/window closed before the battery is plugged in. Sensor should be closed if using NC jumpers, Open if NO jumpers. '''Change Timer Wakeup Interval''' By default, this is set to 1hour - see the diagram above for where the timer resistor is located on trigBoard. You can replace this resistor with any value you want to change the wakeup time - see the TPL5111 datasheet for resistor values: http://www.ti.com/lit/ds/symlink/tpl5111.pdf
| |
| − | | |
| − | '''Powering Up'''
| |
| − | | |
| − | Before mounting the trigBoard in it's final location, a simple bench test is helpful to make sure everything is setup. With the battery and sensor plugged in, simply press the "Wake" button on the board. You should see the LED turn on, then turn off. This is normal, because the firmware checks to see if the WiFi settings are configured, and if not, it just goes back to sleep. To enter in the WiFi settings, you have to press and hold the "Wake" button until you see the LED flash, then let go. The LED should remain solid at this point. You now have 2 minutes to configure the trigBoard. From a computer (easier) or mobile device, go to your WiFi settings and search for available networks. Connect to the "trigBoard" network.
| |
| − | A captive portal window should automatically pop up:
| |
| − | | |
| − | [[File:trigBoardcaptive.png|600px]] | |
| − | | |
| − | If you don't see a captive portal, you may need to open your browser and attempt to load a website. Try to google something. If you still don't see the portal, then you can try connecting directly to the board - in the browser, type in 192.168.4.1 in the address box. That should connect you to the portal. If you're still having problems, try disconnecting the battery from the board and allow the trigBoard SSID to fade away from the available networks on your computer. Then plug the battery back in and try again. Seems that on windows this may take more than one try. I've also seen issues where the computer defaults to the ethernet connection when the WiFi network does not have an internet service. If you think you're having this problem, just unplug the ethernet cable from your computer.
| |
| − | | |
| − | Click configure, and select the network that you trigBoard to use and enter in the password. You'll now see where you want to enter in the private Push Safer key. Then you can give the board a name, and a trigger message. Once that's entered in, click Save and you're all done! Once you click save, watch the LED on the trigBoard. It should start '''flashing''' quickly, indicating that the settings were saved and that it was able to connect to that network. Then, to test, just press the wake button for about a second, or use the sensor switch input. If all was set up properly, you should get a notification!
| |
| − | | |
| − | [[File:configWifimanager.png|600px]]
| |
| − | | |
| − | * If you don't see a flash, the board has failed to connect to your WiFi hotspot. For testing purposes, try reconfiguring to another hotspot, like your phone. That will at least help determine where the problem is.
| |
| − | * If you get the blink, but then when waking the board, it goes to sleep after 5 seconds, with no notification, the board may be having a hard time connecting to your hotspot within 5seconds. You can extend this timeout in the code. Go to the provisioning tab and to this line:
| |
| − | if (millis() - startedAt > 5000)// not there after 5 seconds, let's kill it
| |
| − | | |
| − | == Base Firmware == | |
| − | | |
| − | Note! the board is preloaded with the base firmware out-of-the-box, but if you want to develop/modify your own firmware, this section will go through the steps for getting the base code to compile. Then you can develop your own code to run on the trigBoard!!
| |
| − | | |
| − | Base Firmware Downloads:
| |
| − | [http://kevindarrah.com/micro/Pusher/trigBoardReleaseV7_12_16_18.zip Arduino Code 12/16/18]
| |
| − | [http://kevindarrah.com/micro/Pusher/trigBoardReleaseV7_12_16_18.ino.adafruit.bin Bin File for OTA programming]
| |
| − | First Release
| |
| − | Tested on Arduino v1.8.8, ESP core v2.4.2, WiFi Manager v0.14.0, Arduino JSON v5.13.4
| |
| − | | |
| − | Base Firmware Developed on Arduino IDE - can download [https://www.arduino.cc/en/Main/Software Here] or [https://www.arduino.cc/en/Main/OldSoftwareReleases#previous Here for previous versions]
| |
| − | | |
| − | Then you'll find that the code does not compile and that's because you need several libraries and the board manager installed. Here's what you need:
| |
| − | | |
| − | First, go to File>>Preferences and add this URL to to the "Additional Boards Manager URL". http://arduino.esp8266.com/stable/package_esp8266com_index.json
| |
| − | | |
| − | [[File:BoardsManagerURLnewCore.png|600px]]
| |
| − | | |
| − | Now, the ESP8266 boards will be available for installation. Go to Tools>>Board>>Boards Manager... Search for ESP8266, and go ahead and click install.
| |
| − | | |
| − | [[File:ESP8266Install.png|600px]]
| |
| − | | |
| − | After the boards are installed, you can select any of the ESP8266 boards out there from the Board Selection. For the trigBoard, I have been using the Adafruit Huzzah, here are my settings. Note that I always upload as fast as possible:
| |
| − | | |
| − | [[File:trigHuzzahSettings.png|600px]]
| |
| − | | |
| − | Next, you'll need to install the specific Arduino Libraries I'm using in the base code. The first one is is the [https://github.com/tzapu/WiFiManager WiFi Manager by tzapu] - the easiest way to install the library is to go to Sketch>>Include Library>>Manage Libraries. Then type in WIFImanager. Go ahead and install the library.
| |
| − | | |
| − | [[File:WiFiManager.png|600px]]
| |
| − | | |
| − | Do the same for the [http://arduinojson.org/ Arduino JSON library by Benoit Blanchon] - can just search for JSON.
| |
| − | | |
| − | [[File:ArduinoJSON.png|600px]]
| |
| − | | |
| − | We're also using the Push Safer library to keep things easy. You can get that here: https://github.com/appzer/pushsafer-arduino-library
| |
| − | | |
| − | [[File:pushsaferGit.png|600px]]
| |
| − | | |
| − | Download that zip file, then head over to the Arduino IDE, and add zip library:
| |
| − | | |
| − | [[File:addZipLibrary.png|600px]]
| |
| − | | |
| − | Then that should be it - the other libraries are automatically installed with the ESP8266 board manager.
| |
| − | | |
| − | See the "Testing and Programming" section below for information on loading the code over a wired USB-Serial connection. The other option is to load code wirelessly "OTA - Over the Air". In the "trigBoard Operation" section this is shown.
| |
| − | | |
| − | == Programming ==
| |
| − | | |
| − | {{#evt:
| |
| − | service=youtube
| |
| − | |id=https://youtu.be/5uLtjMjbT08
| |
| − | |dimensions=560x315
| |
| − | }}
| |
| − | Note that the USB-Serial Converter that I designed is known to work - other versions of it may not. Here is the wiki page for the USB-Serial Board: [[The_USB_to_Serial_Converter:]], and can be purchased here: https://www.tindie.com/products/13817/
| |
| − | | |
| − | The OTA link to upload the bin file: '''http://trigboard.local/update'''
| |
| − | | |
| − | [[File:trigBoardv7programmer.jpg|560px]]
| |
| − | | |
| − | == Schematic ==
| |
| − | [[:File:trigBoardV7.pdf PDF Schematic]]
| |
| − | | |
| − | [[File:trigV7SCH.png|1000px]]
| |
| − | | |
| − | == Projects ==
| |
| − | | |
| − | [https://www.youtube.com/watch?v=a2MiyFGWnU0&t=268s Andreas Spiess' Weather Forecaster]
| |
| − | | |
| − | [[WeatherBoard]] BME280 and LMT01 Weather Station
| |
| − | | |
| − | [[EPaperBoard]] E-Paper Display
| |
| − | | |
| − | [[CameraBoard]] Camera System with Arducam
| |
| − | | |
| − | [https://youtu.be/cD4gDeQ5jBI Clear Sky Indicator for Astronomy] Project to connect to https://openweathermap.org to get weather details, then indicate if sky is clear or not.
| |
| − | | |
| − | [[TrigBoardStillOn]] Simple Hack to see check if digital input is still open using the timer. Did you leave the door/lock or whatever open?
| |
| − | | |
| − | [[TrigBoardMotion]] Waking the trigBoard up with motion using a simple PIR sensor.
| |
| − | | |
| − | [[TrigBoardPressure]] Wake the trigBoard from a pressure pad (FSR sensor)
| |
| − | | |
| − | == Mechanical ==
| |
| − | | |
| − | Autodesk link to 3D viewer (you can download step file): https://a360.co/2EIjWEe
| |
| − | | |
| − | [[File:Screen Shot 2019-01-23 at 12.55.40 AM.png|200px]]
| |
| − | | |
| − | == Rev 4 Compatibility ==
| |
| − | | |
| − | Everything is pretty much the same as Rev 4, but if you have code running on the Rev 4 and want to program that on a Rev7, you will have to change how it measures the battery voltage. I changed the voltage divider resistors:
| |
| − | | |
| − | [[File:rev7batMeas.png|400px]]
| |
| − | batteryVoltage = (4 - 3.5)/(712 - 621) ;
| |
| − | batteryVoltage = analogRead(A0) * batteryVoltage + (4 - batteryVoltage * 712);
| |
| − | | |
| − | == Expansion ==
| |
| − | | |
| − | You can design your own "mini" boards to pair up with the trigBoard - soldering wires to the board works, or even pluggable type connectors like [https://www.digikey.com/product-detail/en/mill-max-manufacturing-corp/328-10-105-40-020001/ED10192CT-ND/9490853 these] and [https://www.digikey.com/product-detail/en/mill-max-manufacturing-corp/835-43-005-40-030001/ED10188CT-ND/9490849 these]. (Thanks Daniel B for the tip!)
| |
| − | | |
| − | [[File:expansionTrigBoard.jpg|400px]]
| |
| − | | |
| − | == Disclaimer ==
| |
| − | I'm just a guy who designs boards, so I'll try my best to support you as much as I can and provide tutorials as I have time for. Every board that is sold has been functionally tested, so that they can be programmed, the sleep current is right, they can be woken up, the battery voltage measurement is "close", and active current is consistent with a working board. Also, these boards are for educational, hobbyists, DIYer, maker, and development use only. If you are interested in working this board into your product, please [http://www.kdcircuits.com/#contact contact me] for more information
| |
