LCD

This widget simulates a common 16x2 LCD.

Datastream

  • Simple mode - select or create a datastream of data type integer, double or string for the first and second lines of the display.

  • Advanced mode - select or create a single datastream of data type integer, double or string.

Widget Controls

The widget has no controls.

Mode

  • SIMPLE - the datastream value is shown left justified on each line of the LCD. You can add text before and after the value displayed by navigating to ‘Design’ -> ‘FIRST LINE’ and then enter “/value1/ kg” excluding the double quotes. The datastream value of 3.14159 will be displayed as “3.14159 kg”.

  • ADVANCED - allows you to send clear and positioning commands just like those sent to a physical LCD. See sketch: LCD Advanced Mode

How to process widget with the hardware

When widget is pressed, value is sent and stored into the Blynk.Cloud. After that it's sent to your device.

Reading the widget value: Simple Mode

For the widget configured in Simple mode and datastream V1 assigned to the LCD line 1, and V2 assigned to the LCD line 2:

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

// Assign incoming value from pin V1 to a variable
// according to the datastream data type
int pinValue = param.asInt(); 
// double pinValue = param.asDouble();
// String pinValue = param.asStr()
// String pinValue = param.asString()

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

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

// Assign incoming value from pin V2 to a variable
// according to the datastream data type
int pinValue = param.asInt(); 
// double pinValue = param.asDouble();
// String pinValue = param.asStr()
// String pinValue = param.asString()

Serial.print(“V2: “);
Serial.println(pinValue);
}

Reading the widget value: Advanced Mode

For the widget configured in Advanced mode and datastream V1 of data type string assigned to the LCD:

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

// String pinValue = param.asStr()
String pinValue = param.asString()

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

Changing the datastream value(s): Simple Mode

You can change the value of the datastream assigned to the widget with the hardware or HTTP API. For the widget configured in Simple mode and datastream V1 assigned to the LCD line 1, and V2 assigned to the LCD line 2:

Hardware:

Blynk.virtualWrite(V1, “My LCD Line 1”);	
Blynk.virtualWrite(V2, “My LCD Line 2”);

HTTP API:

https://{server_address}/external/api/update/?token={your 32 char token}&V1=My%20LCD&20Line&202

Changing the datastream value(s): Advanced Mode

You cannot use Blynk.virtualWrite() or HTTP API with the LCD widget in advanced mode because the changes to the datastream will not be reflected in the LCD widget. You must use the functions as demonstrated in the sketch LCD Advanced Mode.

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: LCD Advanced Mode

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()
}

Last updated

Revision created

GITBOOK-1318: change request with no subject merged in GitBook