GitHubBlynk WebsiteLogin to Blynk.Console

Terminal

Displays the assigned datastream of data type string values since the app was last refreshed in a scrolling list. It optionally provides a text input area for the user to assign new values to the assigned datastream. Special commands are available for the hardware to assign data to the datastream using the print/println/write methods.

Note that the terminal display is cleared with every app refresh for Free plan.

With Plus plan the widget stores up to 10 lines of historical data. It stores up to 25 lines with the PRO plan.

Datastream

Select or create a datastream of data type string.

Widget Controls

The widget has the following controls:

  • Scroll - drag the display area vertically to scroll the contents.

  • Text input field: When ‘Input Line’ in settings is enabled, the text input field is displayed and allows the user to enter text that will update the assigned datastream. Note that any user input will have a “>” character before it in the widget display to differentiate it from values obtained from the datastream.

Widget Settings

  • Input line - when enabled, the text input area below the display is shown.

  • Add new line - when enabled, a new line (CrLf) is added after content is entered into the text area.

  • Autoscroll - when enabled, datastream content will be automatically scrolled to show the latest at the bottom of the display area.

How to process widget with the hardware

The datastream value displayed is updated whenever the value stored on Blynk.Cloud changes.

Reading the widget value(s)

For a datastream of data type string assigned to V1:

BLYNK_WRITE(V1) {
// Called when the datastream V1 value changes

// Assign incoming value from pin V1 to a variable
// String pinValue = param.asStr()
String pinValue = param.asString()

Serial.print(“V1: ‘“);
Serial.print(pinValue);
String.println(“‘“);
}

Changing the datastream value(s)

You can change the value of the datastream assigned to the widget with the hardware or HTTP API. For a datastream of data type string assigned to V1:

Hardware:

Blynk.virtualWrite(V1, “my new datastream value”);

Or you can use the following special functions for this widget: 

// Include Blynk library appropriate for your hardware
#include <BlynkSimpleEsp8266_SSL.h> // secure SSL version

// WidgetTerminal must follow Blynk library include
WidgetTerminal terminal(V1);	

void loop() {
  delay(30000);

  // Erase all values in the terminal
  terminal.clear(); 


  // Print values, like Serial.print
  terminal.print();   

  // Print values, like Serial.println()
  terminal.println();
 
  // Write a raw data buffer
  terminal.write();

  // Ensure that data was sent out of device
  terminal.flush();
	
}

HTTP API:

https://{server_address}/external/api/update/?token={your 32 char token}&V1=my%20new%20datastream%20value

Don't put Blynk.virtualWrite()into the void loop() as it can cause a flood of messages and your hardware will be disconnected. Send such updates only when necessary, use flags, or timers.

Sketch: Terminal

Sketch: Basic Sketch

Sketch: Set Property

Sketch: VirtualPinWrite

Sketch: VirtualPinRead

Change Widget Properties

You can change certain properties of the Widget from your hardware. For that, use this command: 

Blynk.setProperty(vPin, "widgetProperty", "propertyValue");

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.

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

Blynk.setProperty(V1, "label", "Air temperature");

Set Widget Color

//#D3435C - Blynk RED 
Blynk.setProperty(V1, "color", "#D3435C");

Disable/Enable

Widget will be greyed out on UI and users won't be able to tap on it.

Blynk.setProperty(V1, "isDisabled", true);

Show/Hide

Widget will be hidden from dashboard. Design your UI so that it doesn't look weird when there is no widget.

Blynk.setProperty(V1, "isHidden", true);

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

Name
Type
Description

{server address}*

string

Get from the bottom right of your Blynk console. More information.

Query Parameters

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: label, color, isDisabled, isHidden

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

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.

BLYNK_CONNECTED() { 
  // Called when hardware is connected to Blynk.Cloud  

  // get the latest value for V1
  Blynk.syncVirtual(V1); 

  // Request Blynk server to re-send latest values for all pins
  Blynk.syncAll()
}
PreviousSuperChartNextVideo Stream

Last updated