Home
Blog
Community
Documentation
Efficacy Paper

API documentation

Introduction

Our documentation

Applications

Herald Applications
Contact Tracing
Device to Device
Bluetooth Mesh Gateways

Herald Protocol

About our protocol
Non contact tracing uses

Design Guide

Herald's Design
Core philosophy
Data used
Protocol lifecycle
Design summary

Herald Payloads

About Payloads
Herald Envelope Header
Interoperability
Herald Common CT Inner Header
Herald Simple Inner Payload
Herald Secured Inner Payload (Draft)
Herald Beacon Payload (Draft)
Herald-compatible Inner Payload
Custom outer & inner payloads

Development & Integration Guide

How to integrate
About the code
API docs
Import Herald
iOS app guide
Android app guide

About Contact Tracing

What is Contact Tracing?
Glossary of terms
Technology Approaches

Bluetooth Research

Our Research
Hardware Issues
Operating System Issues
Crowding
Distance Estimation

Formal Specifications

List and status
Herald Protocol
Beacon Payload
Extended Data Area
Simple Payload
Secured Payload
International Interoperability

API docs

The APIs are all documented and can be found at the below locations:-

Android JavaDoc API
iOS Swift API
C++ - Coming soon

Getting Started

To help you get started, see the documentation.

Documentation

Twitter
Slack
RSS
GitHub

© 2021 Herald Authors. A VMware-backed project.