Getting Started
Platform overview
General Concepts
Downloads
Blynk.Console
BLYNK.CLOUD (HTTPS API)
Troubleshooting
Commercial Use
Legacy Platform Help Articles
Log Events
This tutorial will help you with creating Events in Device Templates
Events are used to track and log important events happening on your devices. Events can also trigger different types of notifications which can be sent over email, as push notifications to Blynk app, or as SMS.
Examples of an Event:
- 1.You need to log a moment when a temperature reached a certain threshold and send a notification to selected users.
- 2.You need to log a total working hours of the device. If it approaches or goes beyond a max value, you would need to notify technical support so that they can replace the device.
2. Create Event
Go to Template -> Edit -> Events tab.
Note: there are two default events (and they can't be edited): Online and Offline.
Let's create a test event
- 1.Click Add New Event
- 2.Name the first event with the name Hello
- 3.Click Create (the event will appear in the Events tab list)
- 4.Repeat the previous step for the second event with the name Error
- 5.Click Save to save and apply the changes made (select Update active device this time)
Note that each event has
EVENT CODE. This event code will be used in the firmware or HTTPS call to trigger it.
3. Sending Events
You can test the Event creation by sending it from Device using Blynk.Edgent firmware API, or with REST API.
Use Blynk.logEvent() firmware API
Blynk.logEvent("event_code", "optional message");For this tutorial you would need to use hello as a name. Here is a pseudo code:
1
if (some_condition){
2
Blynk.logEvent("hello");
3
}
Copied!
Optionally, you can send a custom description with the event. This description will be rendered on Device Timeline.
1
if (some_condition){
2
Blynk.logEvent("hello", "Hello World,") ;
3
}
Copied!
Use REST API
- 1.Navigate to the Device
- 2.Click on its name
- 3.Open Device Info tab
- 4.Find Auth Token there and click on the icon to copy it to the clipboard
Device Info tab
Auth Token. Click copy pictogram here
Now make an HTTP request with the tools you use for that. Make sure to change the
YourAuthToken to the one you copied in the previous step.You can even use your browser for that. Just put it in the URL field and press Enter.
1
https://blynk.cloud/external/api/logEvent?token=YourAuthToken&code=hello
Copied!
Repeat the same with
code=error1
https://blynk.cloud/external/api/logEvent?token=YourAuthToken&code=error
Copied!
4. Checking if Event was logged.
You should see 2 events on the timeline! If you set up notifications, they should have been delivered as well.
Limitations
- You can send only 100 events per devices per day
- When the limit is reached you'll see the notification on the UI in the Device Timeline section
- The maximum description length for the event is 300 chars
Limits could be changed for the White Label clients if required.
Last modified 9d ago