Alias Name
Displays the name of the assigned datastream and optionally permits editing of the name when the Edit mode is enabled.
Datastream
Select or create a datastream of data type integer, double, enumerable, or string. Widget properties (label, color, etc.) are also changed via the datastream, but only for virtual, enumerable, and location pins, not digital and analog pins.
Widget Controls
The widget has no controls.
Mode
View - the assigned datastream ‘Name’ is displayed.
Edit - the assigned datastream ‘Name’ is displayed in an edit box and may be changed by the user.
How to process widget with the hardware
The widget makes no changes to the datastream other than editing the datastream ‘Name’. Changes to the datastream values have no influence on the visual content or behavior of this widget.
Change the Widget Properties
You can change certain properties of the Widget from your hardware. For that, use this command:
Where:
vPin
is: virtual pin number the widget is assigned towidgetProperty
: property you want to changepropertyValue
: 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.
Properties you can change
You can change the properties label, color, isDisabled, isHidden of the widget from your hardware, or via an HTTP API. The URL must be encoded, so spaces in labels must be replaced with %20, and color hexadecimal values in the HTTP API URL must include the hash # character urlencoded as %23.
Change Widget Label
Set Color
Disable/Enable
Widget will be greyed out on UI and users won't be able to tap on it.
Show/Hide
Widget will be hidden from dashboard. Design your UI so that it doesn't look weird when there is no widget.
Change widget properties via HTTPs API
Updates the Datastream Property and all assigned Widgets
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&label=My%20Label
https://blynk.cloud/external/api/update/property?token=GVki9IC70vb3IqvsV0YD3el4y0OpneL1&pin=V1&color=%23D3435C
https://blynk.cloud/external/api/update/property?token=GVki9IC70vb3IqvsV0YD3el4y0OpneL1&pin=V1&isDisabled=true
Path Parameters
Query Parameters
Sync to the latest known state
You can update your hardware to the latest datastream value from Blynk.Cloud after your hardware went offline, and then came online again. Use Blynk.syncVirtual()
to update a single virtual pin, or Blynk.syncAll()
to update all virtual pins. See State Syncing for more details.
Last updated