Skip to main content

Requirements

This page lists OmniCore requirements and related information.

Regions and versions​

Transport Layer Security (TLS)​

OmniCore requires TLS version 1.2 or higher.

MQTT bridge​

MQTT version 3.1.1 is required. The following features are not supported:

  • MQTT QoS 2
  • Arbitrary MQTT topics and subscriptions. For topic requirements, see the section on connecting devices using MQTT
  • Last Will and Testament (LWT)
  • Retained messages
  • Persistent sessions

HTTP bridge​

Secure communication (HTTPS) is required. OmniCore supports HTTP 1.1 only (not 2.0).

Permitted characters and size requirements​

Registries and device identifiers, and their associated fields, are limited to certain characters. These fields are also limited in size (either length or byte size). The following table lists the permitted characters and sizes for each resource:

ResourceLimitations
Registry IDs
  • Permitted characters: [a-zA-Z][-a-zA-Z0-9._+~%]+
  • First character must be a letter ([a-zA-Z])
  • Minimum length: 3 characters
  • Maximum length: 255 characters
Device metadata keys
  • Permitted characters: [a-zA-Z][-a-zA-Z0-9._+~%]+
  • First character must be a letter ([a-zA-Z])
  • Minimum length: 1 character
  • Maximum length: 128 characters
  • Maximum combined total size of all device metadata key-value pairs: 256 KB
Device metadata values
  • Minimum size: 0KB
  • Maximum size: 128KB
  • Maximum combined total size of all device metadata key-value pairs: 256 KB
Subfolders*
  • Permitted characters: [a-zA-Z][-a-zA-Z0-9._+~%]+
  • First character must be a letter ([a-zA-Z])