Quickstart & Configuration¶
Out of the box setup¶
All that’s needed here is a battery and a dry contact used for triggering. Both connectors on the board are standard JST PH 2.0mm Note that the cables may need some force to fully insert.
A good capacity for the trigBoard is 500-1000mAh, but this depends on how often the board will be triggered. Any of these Lithium batteries would work from Adafruit. Or two AA or AAA batteries would work, with a holder like This Note that this battery holder is also available for purchase with your trigBoard as an option :) More details on battery selection can be found here
This is where the notification will end up. For testing, it’s easy to simply use Pushsafer or Pushover - see the Supported Services Page for more information
Setting up Configurator¶
The trigBoard ships with base firmware pre-flashed, so once you hook up the battery, you’re all set to launch the configurator. This works on a bluetooth connection to your computer within Google Chrome.
You need to click the save button next to each parameter after changing it
Don’t forget to Disconnect from the Configurator when complete! The device does not send notifications while the Configurator is active
This is self explanatory, but if you’re using (Pushover, Pushsafer, or IFTTT) then the trigBoard will connect to the WiFI network selected here using DHCP. If you would rather use a static IP, you can also enable this by selecting the check box. Most users just use DHCP, but may have faster connection times by using a static IP:
This is the time the trigBoard will wait before failing to connect to the WiFi network and going back to sleep. For most users, 5 seconds is good enough. Just be careful to not make this too big because if you ever relocate the trigBoard to a new location and need to reconfigure, you’ll have to wait for this timeout before the configurator mode is enabled. I would suggest starting with 5 seconds and if you notice missed events, increase to 10 seconds. If that still gives trouble, then there may be a problem with the WiFi router or signal strength at this location.
This is the name that will be sent along with the push notification message - normally would be “Front Door” “Garage Door” “Mail Box”
The trigBoard will wake on any change of the sensor input - open and close. This setting here is used to decide if a notification is sent. This depends on the application and how you’re planning to use the trigBoard. For a mail box, just open detection might make sense, but for a garage, both open and close would be useful.
Message for Contact Wake¶
When you select which to wake on, the messages are enabled for that selection. These could be “Has Opened” or “Has Closed”, because the firmware will combine the trigBoard name with this message. “Garage Has Opened”
High Speed Trigger¶
Warning! This feature was added for very specific applications where the sensor input rapidly opens and closes. Most users would leave this unchecked. There is a complex analog trigger system designed into the trigBoard and it normally detects the wake event based on the current status of the contact. But in some applications, the contact opens and closes very quickly. For this, the high speed trigger will change to use latched circuitry to determine the wake event. But again, this is more for specific applications and should be left unchecked.
The timer on the trigBoard is extremely useful. This automatically wakes the board up at a specific interval to check various conditions like low battery or if the contact is still closed/open. It is HIGHLY recommended to keep this value as high as possible, so if a check of once an hour (60 minutes) can work for your application, then set for that. Some applications like a checking if the garage door is still open may need a faster interval like 15 minutes, but just note that this will have some impact on battery life. So ideally the units are set to Minutes, but Seconds were added in as an available feature. Note that this can be useful when developing your own firmware for waking the board automatically when uploading to the board. Like I’ll set to 10seconds when developing, so I never have to physically wake the board to upload.
Timer Wake Messages¶
If the timer has been enabled to check contact status, then these are the messages that will be sent - usually set to “is Still Open” or “is Still Closed”, then the combined message might be “The Garage is Still Open” For most applications monitoring doors/windows, the check for if the contact is still open is the only one used.
The clock functionality was added in release 8/16/21 and is extremely powerful. This gives the ability to add timestamps push messages, add a daily wake at a specific time with a custom message and timestamp. This can be useful for “hearbeat” messages or check-ins with a server on a device that rarely wakes. To set the time, first connect to WiFi from the WiFi settings, then the set to NTP time button will be enabled. You can set the timezone offset according to the UTC Time Offset for where you live. You can even make the trigBoard synchronize with the NTP server when the daily wake alarm is activated. But what if you don’t set the time? Well, then the time (as shown in the image) will show the elapsed time from when it was powered up. This can be a useful way to see how long a board has been in service running on that battery. Like here, the time was not set and the timestamp shows this board has been running for 27 days on the battery:
Added in the 11/29/21 release, and appends the signal strength in dBm to the notification packet. Note that this will always be a positive number because the negative character was used as a separator in some projects. So in this example below 58dBm is technically -58dBm. You can read more about RSSI here and see what acceptable values should be. Note that if you have the board configured to send using TCP/UDP and another service, it will append two RSSI values since the UDP/TCP is typically set up as an isolated network. The UDP/TCP value will always be the last one.
Mission Critical Check¶
Added in the 11/29/21 release, and provides a nice feature to ensure the latest contact status message has been sent. There is a small “dead zone” when the board is going to sleep ~200ms or so. So if the board is configured to wake on open and close, there’s a chance like if this monitoring a door, where if the user quickly opens and closes the door that the closure is missed. This new feature sets a timer to just wake a few seconds after the board goes back to sleep to “double check” that the contact state is the same as it was when it sent the original message. If there’s a discrepancy, it will send a fresh message. 5-10seconds should be a good timer setting for this, but the setting is there to make this anything up to a minute to suit the application.
Low Battery Threshold¶
This is the threshold that if the battery is less than this value, a BATTERY LOW message is sent out at the timer interval. Because the trigBoard supports a wide variety of battery options, a setting here needs to be set. For a 4.2V rechargeable lithium battery, maybe 3.3V or so would work. Then for two AA/AAA batteries, set for 2.5V