Image Animation
Last updated
Last updated
This widget allows you to display an animated GIF or APNG image. It is possible to use Lottie animation with a different widget. From your hardware or the HTTP API you can change the image URL, and start and stop the animation.
The widget has the following controls:
URL ADDRESS: The URL to either a GIF or APNG (animated PNG) file. The image will be shown in the preview area at the top of the page.
Auto-Play: Play the animation once when the device is initially displayed in the app, or when the datastream value or properties ‘url’, ‘autoplay’, or ‘loop’ are changed.
Play in Loop: Repeats playing the animation from the start.
Select or create a datastream of data type string. The datastream value of “play” will cause the animation to play, and the value of “stop” will cause the animation to stop.
You can change the properties of the widget from your hardware using the command:
Where:
vPin
is: virtual pin number the widget is assigned to
widgetProperty
: property you want to change
propertyValue
: value of the property you want to change
Don't put Blynk.setProperty()
into the void loop()
as it can cause a flood of messages and your hardware will be disconnected. Send such updates only when necessary, or use timers.
You can change the properties url, autoplay, and loop of the widget from your hardware, or via an HTTP API. Substitute ‘V2’ in the examples below with the datastream virtual pin reference (V0, V1 ...V255) you have configured for this widget. Make sure any string values are URL encoded.
GET
https://{server_address}/external/api/update/property?token={your 32 char token}&pin={your vPin}&{property}={value}
The endpoint allows you to update the Datastream Property value via GET request. All widgets (both web and mobile) that are assigned to this datastream will inherit this property. The Datastream Property is persistent and will be stored forever until you change it with another value. In order to clear the property you need to clear the device data in device actions menu.
Example:
https://blynk.cloud/external/api/update/property?token=GVki9IC70vb3IqvsV0YD3el4y0OpneL1&pin=V2&autoplay=true
Name | Type | Description |
---|---|---|
{server address}* | string | Get from the bottom right of your Blynk console. More information. |
Name | Type | Description |
---|---|---|
token* | string | Device auth token from Device info |
pin* | string | The datastream virtual pin (should start with "v") |
property | string | The property of the widget you want to update: |
autoplay | string | true or false |
loop | string | true or false |
url | string | the image URL, should be urlencoded |
You can update your hardware to the latest datastream value from Blynk.Cloud after your hardware went offline, and then came online again.
Use the Blynk.virtualWrite()
command to set the datastream value to “play” to cause the animation to play, and the value “stop” to cause the automation to stop playing.
Use the Blynk HTTP API to set the datastream value to play to cause the animation to play, and the value stop to cause the automation to stop playing.
GET
https://{server_address}/external/api/update/property?token={your 32 char token}&{pin}={value}
Example:
https://blynk.cloud/external/api/update/property?token=GVki9IC70vb3IqvsV0YD3el4y0OpneL1&V2=stop
Name | Type | Description |
---|---|---|
{server address}* | string | Get from the bottom right of your Blynk console. More information. |
Name | Type | Description |
---|---|---|
token* | string | Device auth token from Device info |
pin* | string | The datastream virtual pin (should start with "v") |
value | string | The desired value of the pin (play or stop) |
You can configure the hardware to respond to a change in a datastream value by configuring the BLYNK_WRITE()
command.