Skip to content

Endpoints

View as Markdown

An endpoint is an addressable resource in Port OS. A connected light, thermostat, or simulator appears as an endpoint that your application can discover and control.

Identity and names

The endpoint ID is the stable address returned by discovery. Copy the full ID when you send a request. A display name helps a person select a device, but names can repeat or change.

Interfaces and routes

Interfaces describe the endpoint's supported capabilities, messages and attributes. A route connects an endpoint to a provider. More than one route can contribute to an endpoint. Inspect the available interface before sending a command.

State and availability

Attributes report observed state. An unavailable endpoint may still appear in discovery, but control or state reads can fail until its provider reconnects. A successful command dispatch does not establish the physical result.

Start with Find connected devices or the Quick start.