<!-- Canonical source: https://github.com/deancochran/ftms/blob/2586e33ac88d5d945d9658e063bb909cd58462bd/docs/README.md; revision: 2586e33ac88d5d945d9658e063bb909cd58462bd -->

# Documentation

<a id="start-here-humans-and-coding-assistants"></a>

## Start here

1. [Understand FTMS](https://deancochran.github.io/ftms/start/ftms-explained/index.md): protocol bytes, units, and what the libraries do.
2. [Choose a language](https://deancochran.github.io/ftms/start/choose-language/index.md): install and decode using any of the nine ports.
   [Installation and upgrades](https://deancochran.github.io/ftms/start/installation/index.md) distinguishes latest selection from reproducible pins.
3. Check [current releases](https://deancochran.github.io/ftms/project/releases/index.md) and prerelease status before choosing a dependency.
4. Find your [API reference](https://deancochran.github.io/ftms/reference/api/index.md), then consult the
   [TypeScript and C cookbook](https://deancochran.github.io/ftms/integration/cookbook/index.md) or your package's examples.
5. Keep the [consumer adapter seam](https://deancochran.github.io/ftms/project/architecture/index.md#consumer-adapter-seam) explicit,
   then use the [JavaScript/C transport recipes](https://deancochran.github.io/ftms/integration/transports/index.md) where applicable.
   Consult [troubleshooting](https://deancochran.github.io/ftms/integration/troubleshooting/index.md) for diagnostics.

Keep Bluetooth discovery, timing, permissions, session ownership and physical
control safety in your application. A valid request or capability report is not
authorization to execute a command.

<a id="reference-and-contracts"></a>

## Reference and compatibility

* [API references by language](https://deancochran.github.io/ftms/reference/api/index.md)
* [Support profiles](https://deancochran.github.io/ftms/reference/support-profiles/index.md): definitions of wire roles and optional modules
* [Protocol coverage](https://deancochran.github.io/ftms/reference/coverage/index.md): implementation and verification scope
* [Versioning](https://deancochran.github.io/ftms/project/versioning/index.md): package compatibility, protocol and corpus identities
* [Capability evidence contract](https://deancochran.github.io/ftms/reference/capabilities/index.md)
* [Wire compatibility](https://github.com/deancochran/ftms/blob/main/shared/protocol/wire-compatibility.md) and [numeric inputs](https://github.com/deancochran/ftms/blob/main/shared/protocol/numeric-inputs.md)

## Releases

* [Current public packages and exact release evidence](https://deancochran.github.io/ftms/project/releases/index.md)
* Package-owned changelogs describe changes; publication records establish artifact identity.
* [Planned 1.0 milestone](https://deancochran.github.io/ftms/project/release-one-zero/index.md): preparation status, not a published release

Migration guidance will be based on reviewed interface differences, not inferred
from the target version. Current installation commands remain valid until a new
public artifact is verified.

<a id="evidence-not-installation-instructions"></a>

Historical records are indexed in [Audits and evidence](https://deancochran.github.io/ftms/project/evidence/index.md); they are not
current installation instructions.

<a id="maintainers-and-contributors"></a>

## Contributors and maintainers

* [Contributing](https://deancochran.github.io/ftms/project/contributing/index.md), [architecture](https://deancochran.github.io/ftms/project/architecture/index.md), [roadmap](https://deancochran.github.io/ftms/project/roadmap/index.md), [security](https://deancochran.github.io/ftms/project/security/index.md)
* [Conformance runner and corpus accounting](https://github.com/deancochran/ftms/blob/main/shared/conformance/README.md)
* [Universal measurement interfaces](https://deancochran.github.io/ftms/integration/universal-measurements/index.md): native consumer APIs, design and acceptance criteria
* [Release process and per-port runbooks](https://deancochran.github.io/ftms/project/releasing/index.md)
* [Equipment testing](https://deancochran.github.io/ftms/project/equipment-testing/index.md) and [simulation](https://github.com/deancochran/ftms/blob/main/docs/simulation.md)
* [Historical audits and evidence](https://deancochran.github.io/ftms/project/evidence/index.md)
* [Documentation site development and deployment](https://github.com/deancochran/ftms/blob/main/site/README.md)

Public integration does not require a repository checkout or private specification
context. Exported declarations and public headers remain package-owned references;
the site also publishes generated TypeScript API documentation.
