Specifications

Formal specifications

These pages hold the formal specification for Herald protocols, payloads, and subsystems. Each item also links to a web based overview page.

Specifications:-

Title Status Links
Herald Protocol Implemented Overview page
Specification HTML
Herald Beacon Payload Draft, Sample implementation Overview page
Specification HTML
Herald Extended Data area Payload Draft, Sample implementation Specification HTML
Herald Simple Payload Draft, Sample implementation Overview page
Specification HTML
Herald Secured Payload Draft Overview page
Specification HTML
Herald International Interoperability Draft Overview page
Specification HTML

To raise issues for these protocols, please add them to the main Herald GitHub issues webpage

Terminology

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in these documents are to be interpreted as described in RFC 2119.

Getting Started

To help you get started, see the documentation.