OpenInfrared Documentation
Welcome to the documentation for OpenInfrared. Use the sidebar to navigate.
- User Guide — Setup, usage, and troubleshooting for your Point Hub
- API Reference — HTTP API documentation for the Point Hub
User Guide — Coming Soon
The user guide is currently being written. Check back soon.
Topics will include:
- Getting started with your OpenInfrared Point device
- Configurating your device
- Learning and sending infrared commands
- Using Instant Remote via QR code and NFC
- Troubleshooting
API Reference
This reference covers the HTTP API exposed by the OpenInfrared Point Hub. Endpoints are served over HTTP. The base URL is your hub’s IP address followed by /api, e.g. http://192.168.0.100/api. Example requests will use this address, be sure to replace it with yours.
Endpoints
Control
| Method | Path | Description |
|---|---|---|
POST | /action | Send a full action |
POST | /activity | Turn on or off an activity |
GET | /trigger/{id} | Send a simple action via a GET request |
POST /action
Sends an action to be resolved and dispatched to the appropriate commands.
Request
Body
| Field | Type | Description |
|---|---|---|
id | string | Action identifier, e.g. "power_on" |
role | string | (optional) Role to scope the lookup, e.g. "display", "media", "audio", "avr", "scene" |
dvc | object | (optional) Device to scope the lookup |
Responses
| Status | Body |
|---|---|
| 200 OK | {"message": "Found in Layout"} |
| 404 Not Found | {"message": "Not found"}} |
Example
Bash command
curl --header "Content-Type: application/json" \
--request POST \
--data '{"action": {"id": "power_on", "role": "tv"}}' \
http://192.168.0.100/api/action
POST /activity
Sets the active activity, automatically running the power, input, and sequence transition. Pass null to deactivate all activities.
Request
Body
| Field | Type | Description |
|---|---|---|
name | string | null | Activity name as defined in config, or null to deactivate |
state | “on” | “off” | (optional) Explicity set the desired state of the activity. No value defaults to toggle operation |
Responses
| Status | Body |
|---|---|
| 200 OK | |
| 404 | "message": Not found"} |
Example
curl --header "Content-Type: application/json" \
--request POST \
--data '{"name": "Watch tv", "state": "on"}' \
http://192.168.0.100/api/activity
GET /trigger/{id}
Shortcut for triggering an action by its identifier. Equivalent to POST /action with only the id set.
Useful for clients limited to GET requests.
Request
| Path Parameter | Type | Description |
|---|---|---|
id | string | Action identifier, e.g. "power_on", "volume_up", "power_on_long" |
Responses
| Status | Body |
|---|---|
| 200 OK | {"message": "Found in Device"} |
| 404 Not Found | {"message": "Not found"} |
Example
Bash command
curl http://192.168.0.100/api/trigger/power_on