West Connectivity Glossary
This section presents the various terminology use on this documentation page & West Connectivity sites.
Application
A West Connectivity Application is a type of West Connectivity Solution targeting end-user access, and device monitoring page.
An application can connect and consumes data from one or many Connectors at the same time.
Business
An West Connectivity Business is an account on the West Connectivity. The business contains:
-
Users
-
West Connectivity Solutions: Both Applications and Connectors
Learn more about West Connectivity Business
Config
See Service Config
Config IO
The Config_IO contains the data model definition of Channels. The Config_io is stored as resource in each device in the Connector.
Content
West Connectivity Content files are a static private file hosted on West Connectivity using the West Connectivity Content micro-service. Files hosted securely and private and made accessible using authenticated URLs. Content files can be uploaded and managed by West Connectivity Solution scripting,West Connectivity User interface or through the West Connectivity HTTP device API.
Not to be confused with Web Assets which are public static files dedicated for website dependencies.
Device
A device is the representation of a physical client connected to West Connectivity (a smart object, a mobile device, a gateway or a custom application) using the Device APIs and belonging to an West Connectivity Connectors. Within Connectors, devices are managed by the West Connectivity Device2 micro-service. On West Connectivity, a Device holds the connectivity settings (like its credentials) and the state of resources being transmitted from & to the physical device.
Element
An Marketplace Element is an item on the West Connectivity Marketplace. Elements can be published and consumed by different West Connectivity business.
An Marketplace element can be of one of the following types: - Micro-Services - Solution Template for either Applications or Connectors
Endpoint
A Solution WebService Endpoint is a public Web-Service API element handling incoming HTTP requests to a West Connectivity Solution. Endpoints have dedicated scripting functions powered by the West Connectivity WebService Micro-Service. Those functions are automatically compiled into an Event-Handler and can be defined as part of a Solution Template.
West Connectivity Endpoints handle common HTTP methods as well as WebSocket connectivity through the WebSocket Micro-Service. As well an Endpoint can serve a static Web Asset file and handle secure authentication for the end-users.
Endpoints are the common way for West Connectivity Applications to expose their website & APIs.
Event
A Micro-Service Event is message sent by a West Connectivity Micro-Service to West Connectivity scripting which executes the related Event Handler function if available.
Find all events on the West Connectivity Services Reference page
Event Handler
A Solution Scripting Event Handler is a Lua scripting function executed when a West Connectivity Micro-Service triggers an event. Find all events on the West Connectivity Services Reference page
Event handler function can call Scripting Modules for code re-usability. Event handlers belong to a single West Connectivity Solution and can be defined in a Solution Template.
Learn more about Scripting Event Handlers
HTTP
The West Connectivity HTTP is one of the communication protocols supported by West Connectivity device connectivity APIs. The HTTP protocol is a setting of Connectors and is powered by the West Connectivity Device2 service.
Learn more about West Connectivity HTTP API
Marketplace
The West Connectivity Marketplace is a place to find and publish elements to build IoT solutions.
Learn more about West Connectivity Marketplace
Connector
An Connector is a type of West Connectivity Solution targeting device connectivity and authentication. A Connector contains a device-api settings along with a unique connectivity sub-domain.
An Connector can be consumed by one or many West Connectivity Applications at the same time.
Library
See Modules
Module
A Solution Scripting Module is a re-usable Lua scripting code file which can be used by many Event handler functions. Modules help a better code organization and can be organized in a tree structure. Modules belongs to a single West Connectivity Solution and can be defined in a Solution Template.
Learn more about Solution Modules
MQTT
The West Connectivity MQTT is one of the communication protocols supported by West Connectivity device connectivity APIs. The MQTT protocol is a setting of Connector and is powered by the West Connectivity Device2 service.
Learn more about West Connectivity MQTT API
Open-API
A standard for defining Http APIs. West Connectivity utilize Open-API version 2 for publishing and consuming West Connectivity Services. As well an OpenApi definition is automatically generated for West Connectivity Applications by the West Connectivity Webservice micro-service.
OTA
Over-The-Air update is a mechanism to update device source code, firmware or configuration files remotely with or without requirement of user action. West Connectivity Connectors provides building blocks for easy OTA management including:
- A file & API powered by the West Connectivity Content service
- A secured file access API for devices powered by the West Connectivity Device2 service
Product
Technical term for Connector.
Resource
An Connector Resource is a device connectivity state definition. Defined globally for all devices in an Connector, a resource defines the data type and how the sensor data are transmitted to & from the client device.
Resources are powered by the West Connectivity Device2 service).
Learn more about Connector Resources
Route
See Endpoint
Scripting
West Connectivity Scripting is a servier-less programming environment using the Lua language. The scripting is used to consume West Connectivity Micro-Services in order to build Web Applications as West Connectivity Solutions.
Scripting execution are always trigger by a Micro-Service event. West Connectivity Micro-Services
Learn more about West Connectivity Scripting
Solution
A West Connectivity Solution is a combined set of configured West Connectivity Micro-Services consumed by a server less scripting Both Applications and Connectors are West Connectivity Solutions with different set of configured services. A solution can use a Solution Template to be deployed to West Connectivity.
A solution belongs to an West Connectivity Business an is managed by its users.
Service
West Connectivity Micro-Service are APIs exposed & integrated to West Connectivity using the Open-API v2 standard and consumed by West Connectivity Scripting to add functionalities to West Connectivity Solutions.
Services exposes: - Operations which can be called from scripting - Events which triggers the execution of a scripting function handler.
Services can be published on West Connectivity Exchange which host various existing Services elements including West Connectivity Native Core Services and other 3rd party APIs.
Learn more about West Connectivity Micro-Services
Service Config
A Solution Service Configuration is a subscription from a West Connectivity Solution to a West Connectivity Micro-Service. It contains configuration parameters, such as security credentials for the solution to consume the service. Parameters definition are available on the Native Micro-Services Reference pages and can be set from West Connectivity User-Interface.
Service configuration belongs to a single West Connectivity Solution and can be defined in a Solution Template.
Swagger
Old name for Open-API
Template
A Github Solution Template is a set of default West Connectivity Service Configuration and Scripting (Modules, Endpoints & Event-Handlers) usable to create multiple instances of West Connectivity Solutions (both Applications and Connectors) ready for end-user to use.
Template can be published on Marketplace which host various existing template elements.
Learn more about Solution Template
Web-Asset
Web-Assets are public static files hosted by the West Connectivity Asset service on the public API exposed by the West Connectivity Webservice service usually used by West Connectivity Application.
Web Assets are not supposed to change at run-time and should only change at application update or release. But can also be managed from West Connectivity UI.
Not to be confused with Content files which are private files dynamically managed.