LogoLogo
GitHubBlynk WebsiteLogin to Blynk.Console
  • Introduction
  • Getting Started
    • Supported Hardware
    • Quickstart
      • Next Steps After Quickstart
      • Quickstart Device: Code Overview
      • Troubleshooting
    • Device Activation Methods
      • Manual Device Activation
      • WiFi provisioning
      • Static Token
    • Template Quick Setup
      • Set Up Datastreams
      • Set Up Web Dashboard
      • Set Up Mobile App Dashboard
      • Prepare Your Code
      • Test your Template
    • Send Data From Hardware To Blynk
    • Control Devices (GPIOs and beyond)
    • Events
    • Notifications (Alerts)
    • Sign Up / Sign In
  • General Concepts
    • Developer Mode
    • Device
    • Device Template
    • Connection Lifecycle
      • Disconnections And Heartbeat
    • Users
      • Multi-tenancy
    • Organizations
    • Automations
      • Forward Device Data
  • Message Usage
  • Integration Guides
    • Node-RED
    • The Things Stack
      • Getting Started
      • Device Grouping
      • Automated Device Onboarding
      • System DataStreams
    • Blues
    • NCD Industrial Vibration Sensor
    • Particle - monitor with Blynk
    • Particle - control with Blynk
    • AWS IoT Core
  • Myriota
  • OpenWeather
  • Blynk.Console
    • Overview
    • Dashboards
      • Dashboard Widgets
    • Devices
      • Device profile
        • Dashboard
        • Device Info & Metadata
        • Notifications & Events
        • Developer tools
          • General
          • Datastreams
          • Testing
          • Actions Log
      • Actions with devices
      • Segments
      • Filters
      • Notifications Settings
      • Device Sharing
    • Locations
      • Location Profile
      • Assigning Devices to the Locations
    • Organizations
      • Create a Sub-Organization
      • Working with Sub-Organizations
    • Users
      • User Profile
    • Device Templates
      • Working With Templates
      • Info
        • Offline Ignore Period
        • Manufacturer
        • Template ID
        • Categories
        • Hotspot Prefix
      • Datastreams
        • Datastream Settings
          • Name
          • Alias
          • Virtual Pin
          • Color
          • Data Type
          • Min Value
          • Max Value
          • Default Value
          • Save RAW Data
          • Invalidate Value
          • Wait for confirmation from device
          • Sync with latest server value every time device connects to the cloud
          • Expose to Voice Assistants
        • Virtual Pin
        • Location
        • Enumerable
      • Web Dashboard
        • Multiple Dashboard Tabs
      • Metadata
        • Metadata Tutorial
      • Connection Lifecycle
      • Events
        • Custom Events
          • Event Settings
          • How to Send/Log Events
          • Content Events
        • Notifications Settings
          • Custom Sounds and Critical Notifications
      • User Guides
      • Assets
    • Widgets (Console)
      • Switch
      • Slider
      • Number Input
      • Image Button
      • Web Page Image Button
      • LED
      • Label
      • Gauge
      • Chart
      • Map
      • Image Gallery
      • Custom Chart
      • Heatmap Chart
      • Video
      • Bitmask Table
      • Gradient Ramp
      • Terminal
      • Segmented Switch
      • Alarm & Sound Widget
      • Modules
    • Blynk.Air
      • Shipment Details
      • Shipment Management
        • New Shipping
      • Device shipment statuses
      • User-Controlled Shipments
    • Settings
      • Organization Settings
        • General
        • Users
        • Locations (Job Site or Facilities)
        • Tags
      • Roles and Permissions
      • Developers
        • OAuth2
        • Webhooks
        • Create New Webhook
      • Integrations
    • User Profile Menu
    • Limits
  • Blynk.Apps
    • Overview
    • Mobile Dashboard Editor
    • Device Header Constructor
      • Header Design
      • Header Mini Widgets
        • Connection Status Widget
        • Last Reported Widget
        • Tabs Widget
        • Datastream Value Widget
        • Image Widget
        • Battery Level Widget
        • Signal Level Widget
        • Tags Widget
      • Header Buttons
    • Pages
    • Widgets (app)
      • Common Widget Settings
      • List of Datastreams types supported by Widgets
    • Widgets Controllers
      • Button
      • Styled Button
      • Icon Button
      • Image Button
      • Slider
      • Vertical Slider
      • Step Slider
      • Vertical Step Slider
      • Joystick
      • zeRGBa
      • RGB Light Control
      • Step H
      • Step V
      • Slope Control
      • Switch
      • Level Slider
      • Level Slider with Switch
    • Widgets Displays
      • Value Display
      • Labeled Value
      • LED
      • Gauge
      • Radial Gauge
      • Enhanced Gauge
      • LCD
      • Simple Chart
      • SuperChart
      • Terminal
      • Video Stream
      • Level H
      • Level V
      • Image Gallery
      • Gradient Ramp
      • Icon
      • Image Animation
      • Lottie Animation
    • Widgets Interface
      • Tabs
      • Menu
      • Map
      • Text Input
      • Numeric Input
      • Time input
      • Segmented Switch
      • Icon Segmented Switch
      • Text
      • Formatted Text
      • Dynamic Spacer
    • Widgets Other
      • Music Player
      • WebPage Button
      • WebPage Image Button
      • Alias Name
    • Main Menu
      • My Profile
      • Organization
      • Settings
      • Help
      • About
      • Log Out
    • Devices
      • Add New Device
    • Automations
    • Notifications & Events
  • Blynk.Edgent
    • Blynk.Edgent overview
    • Blynk.Inject and Blynk.Air
    • OTA: Firmware Over-The-Air updates
  • Blynk.NCP
    • Blynk.NCP overview
    • Supported Connectivity Modules
    • OTA: Firmware Over-The-Air updates
  • Blynk Library - firmware API
    • Installation
      • Install Blynk Library in Arduino IDE
      • Install Blynk Library for Platformio.org
      • Install ESP8266 core for Arduino IDE
    • Configuration
    • Connection Management
    • Device Online/Offline Status
    • Digital/Analog Pins
    • Virtual Pins
    • Widget Properties
    • State Syncing
    • Timers
    • Time (RTC clock)
    • Timezone / Location
    • Log Event
    • Metadata
    • Debug
    • Reboot
    • Over-The-Air Firmware Updates (OTA)
    • Other
    • Limitations and Recommendations
    • Blynk Protocol
  • BLYNK.CLOUD MQTT API
    • Device MQTT API
      • Authentication
      • Topic Structure
      • Datastreams
      • Widget Properties
      • Events
      • Metadata
      • Timezone/Location
      • OTA
      • Miscelaneous
      • Code Examples
  • BLYNK.CLOUD HTTPS API
    • Device HTTPS API
      • Get Datastream Value
      • Get Multiple Datastream Values
      • Get Historical Data From Device
      • Update Datastream Value
      • Update Multiple Datastreams Simultaneously
      • Upload a Set of Timestamped Data
      • Update Widget/Datastream Property
      • Send/Log An Event
      • Get Device Metadata Value
      • Update Device Metadata Value
      • Is Device Connected
      • Upload a File
      • HTTPS API Troubleshooting
    • Platform API
      • Authentication
      • Ogranization API
        • Get Own Organization Info
        • Get Organization Info
        • Search Organizations
        • Create Organization
        • Get Static Tokens
        • Get Organization Tags
        • Get Organization Automations
      • Devices API
        • Get All Devices
        • Search Devices
        • Get Devices by Owner Email
        • Get Devices in user organization
        • Get Recently Activated Devices
        • Get Device Info
        • Get Connection Status
        • Create Device
        • Edit Device
        • Get Datastream Values
        • Update Datastream Value
        • Update Multiple Datastreams Values
        • Import Datastream Values
        • Update Datastream Property
        • Get Datastream Historical Data
        • Get Device Metadata
        • Update Device Metadata
        • Get Device Tags
        • Get Device Timeline Log
        • Log a Device Event
        • Get Actions Log
        • Erase All Data
        • Remove Device Owner
        • Transfer Device
        • Delete Device
      • Users API
        • Get All Users
        • Search Users
        • Create New User
        • Invite User
        • Get User Info
        • Update User Role
      • Templates API
        • Get All Templates
        • Get Template Info
        • Get Template Metadata
        • Get Template Datastreams
        • Get Template Events
    • Security
  • Downloads
    • Blynk Mobile Apps
    • Blynk Library
  • Troubleshooting
    • General Issues
    • Developer Mode
    • Changes from Blynk 0.1
      • Migrating to the new Blynk - Full Guide
    • Glossary
    • Links
  • Commercial Use
    • Deploying Products With Dynamic AuthTokens
    • Deploying Products With Static Tokens
    • Working With Clients
    • Supported topologies
    • Business Plan (White Label Solution)
      • App Publishing Process And Timeline
      • What's Needed To Publish Your Apps And Go Live
      • Branding Materials
      • Custom Email Address For Transactional Emails
      • Application Settings
        • General
        • Design
        • Mobile Apps
        • Sign Up
  • Add-Ons
    • Add-on list
    • Amazon Alexa
    • Google Assistant
    • Localization
    • Database Access
    • Marketing
Powered by GitBook
On this page
  • Common Metadata settings for all Types:
  • Basic Metadata types
  • Additional Metadata types available:

Was this helpful?

  1. Blynk.Console
  2. Device Templates

Metadata

PreviousMultiple Dashboard TabsNextMetadata Tutorial

Last updated 10 months ago

Was this helpful?

Metadata is a set of key:value data attached to every device. Keys are static, and values are related for each device.

For example, a Serial Number Metadata field can be attached to every device, but the actual value is different.

Unlike Datastreams, Metadata is not supposed to change very often.

Metadata can be of different types. Choose the most relevant type for every characteristic. For example, if you would need to associate Serial Number with every product, add the “Number” metadata field. Metadata is also used during device provisioning and configiration process. Staff, installing the equipment will be able to fill it in.

Metadata can be edited by users based on their access level.

Default value can be set to each Metadata, be changed during Add Device procedure and edited any time later.

Common Metadata settings for all Types:

Most of the text fields have 200 characters input limit. Specific differences will be shown in Type info.

  • Metadata Type Name – type default value that will be used and can be changed during Add Device procedure.

  • Advanced Settings – click + to access the following settings:

    • Short Description – fill this field with information corresponding to the hint "Help end-users understand what this field is about and how it will be used." 100 characters limit.

    • Mobile App Provisioning

      • Include in Mobile App Provisioning (switch) – enabling this option allows to edit current Metadata Field during Device Provisioning

      • This is a required field (checkbox) – marking the checkbox makes current Metadata Field mandatory during Device Provisioning

      • Exclude from “Recently used profile” (checkbox) – marking the checkbox excludes current Metadata Field during Provisioning of the next Device

Basic Metadata types

Those 5 are present in any Product and can not be deleted:

  • Device Name – here you can type default Device name.

  • Device Owner – here you can type default Device Owner name or Email.

  • Location – here you can type default Location name.

    • PREMISES ELEMENTS TO INCLUDE ALONG WITH THE ADDRESS (un/mark desired checkboxes):

      • Building Name

      • Floor

      • Unit

      • Room

      • Zone

  • Device Timezone – select actual or preferred Timezone from the dropdown list

  • Hotspot Name – here you can type default Hotspot name.

Additional Metadata types available:

  • Text – name this field any way you want and type default value for it. 255 characters limit for both fields.

  • Number – field name examples: "Serial number", "Unit S/N", "Plate Number", etc..

    • DEFAULT VALUE – set default value up to 15 digits. Stepper buttons are available for this field.

    • MIN/MAX VALUES (OPTIONAL) – set value range limits. Stepper buttons are available.

    • STEP – (Optional) set values change amount per one step. Stepper buttons are available.

  • Unit – field name examples: ""Temperature", "Volume", ''Pressure", etc..

    • VALUE – set default value up to 15 digits. Stepper buttons are available for this field.

    • UNITS – select metric or imperial unit from the dropdown list.

    • MIN/MAX VALUES (OPTIONAL) – set value range limits. Stepper buttons are available.

    • STEP – (Optional) set values change amount per one step. Stepper buttons are available.

  • Time Range – field name examples: "Startup Delay", "Work period", etc..

    • FROM and TO – select or type HH:MM value for each margin of the period. Now option is available – sets actual time for the selected field. Confirm by clicking OK. Reset by X

  • Contact – field name examples: "Contact Person", "Representative", etc.. Un/mark checkboxes below to activate those fields.

    • Allow default values (switch) – enable this option to open default values fields for all the entities below:

      • First Name

      • Last Name

      • E-mail Address – validation is restricted to Email format here

      • Phone Number

      • Street Address

      • City

      • State

      • ZIP Code

      • Country

      • Street Address 2

  • Time – field name examples: "Sunrise", "Sunset", "Start", etc.. Select or type HH:MM value. Now option is available – sets actual time for the selected field. Confirm by clicking OK. Reset by X

  • Cost – field name examples: "Maintenance cost", "Transit price", etc..

    • CURRENCY – select the currency available in the dropdown list: USD, EUR, GBP, CNY, RUB

    • PRICE – set default price value

    • PER QUANTITY – set default numeric value of UNITS – select metric or imperial unit from the dropdown list.

    • MIN/MAX VALUES (OPTIONAL) – define the prices range

  • Coordinates – field name examples: "Factory Location", "Shipping Facility", etc..

    • LAT – set latitude default value here, LON – set longtitude default value here

  • Switch – this field purpose is to show to options of the same entity

    • STRING – give a name or a description of an entity.

    • OPTION A – set or describe one of two possible options. No characters limitations.

    • OPTION B – set or describe second of two possible options. No characters limitations.

  • Device Reference – field name examples: "Other boards versions", "Part of group with", etc..

    • PRODUCT(S) – type/search/select the existing Product/s

  • List – name a list of entities you want to create.

    • OPTIONS – create a list of entitites by adding them to this field. No characters limitations. Remove entity by clicking X.

  • Table – here you can add .csv format table

    • TEXT – name the table you'll add.

    • Upload data file (.csv) – click this area and your PC browser window will be opened. Select the .csv table you want to add and confirm the action. Drag'n'Drop is supported.

IMEI – type/paste default here. 15 digits limit.

ICCID – type/paste default here.

Firmware Update Control – provides an option to users .

International Mobile Equipment Identity
Integrated Circuit Card Identifier
manually control device firmware updates
Metadata type names