Glossary

Term

Description

SDKAn SDK, or Software Development Kit, 
APIAn API, or Application Programming Interface,

Product

An actual device that translates and communicates data & activity from native hardware 

JSON Files

JSON files contain data structures and objects in a standard data interchange format that is lightweight, text-based and human readable. JSON files are considered a language independent format

Product Line

A group of products defined by the same type of configuration

Firmware

A firmware is a file that has code and data that can be flashed to an embedded system

Agent

An agent is a software module that runs on the embedded device

Agent Portal
Terminal

User Fields

Use to manage custom user fields for Product lines, Reporting group, Products, Dynamic Endpoint

Virtual ProductA Virtual Product is a unique virtual ID within the portal used to represent a physical product
Attribute

An attribute is the specification that defines the property of any product/endpoint. It can be considered a metadata for the endpoints. It is the read only data sent from the device

CommandCommands are the instructions to perform some kind of task or function on the device. These can be called from the cloud
Settings

Setting is used to manage read/write values by different setting parameter type for the products.

OTA ServicesOTA (Over The Air) Services allows customers to remotely update the firmware on their devices, including bug fixes and device security, over the device's life
OTA GroupAn OTA group can be created when customers need to update the firmware on multiple devices all at once (i.e. updating a group of similar products or product lines)
PackageA Package is set of instructions programmed for a device.
Package GroupPackage group is the combination of the APKs, firmware’s and connection Config which allows adding a new firmware version for the updates.
ManifestA manifest is an actual software package link which is combination of all the added packages under corresponding package group
EndpointAn endpoint (also known as a product or peripheral) is any hardware device that can be used to measure some aspect of the real world.  An example would be a blood pressure cuff or weight scale
Static Endpoint
Dynamic Endpoint
Reporting GroupReporting groups are used to map virtual products and users in one particular group.