Segmented Switch
Last updated
Last updated
Presents two or more independently selectable options as labeled buttons or labeled buttons with icons and then updates the datastream with a numeric value corresponding to the index of the option selected by the user (index start is 0).
Select or create a datastream of data type integer or enumerable.
The widget has no controls other than buttons that allow the user to select the configured options.
When button is pressed, value is sent and stored into the Blynk.Cloud. After that it's sent to your device.
Example code:
You can set the state of the widget by updating the assigned datastream value using the hardware or HTTP API.
Hardware:
For a datastream V5 assigned data type of integer or enumerable, the following will change the option selection to the second (index = 1):
HTTP API:
Sketch: Basic Sketch
Sketch: Set Property
Sketch: VirtualPinWrite
Sketch: VirtualPinRead
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 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 labels, label, color, isDisabled, isHidden, and page 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.
The labels property for the two or more widget options can be changed from the hardware with this command:
The labels property can also be changed from HTTP API:
Widget will be greyed out on UI and users won't be able to tap on it.
Widget will be hidden from dashboard. Design your UI so that it doesn't look weird when there is no widget.
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
{property}
string
The property of the widget you want to update: onLabel
, offLabel
, label
, color
, isDisabled
, isHidden
, and page
label
string
the text used as widget label
color
string
button color hexadecimal, must include the hash # character urlencoded as %23
isDisabled
string
true or false
isHidden
string
true or false
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.