B.2 HTTP

B.2 HTTP

This page provides a comprehensive overview of the available HTTP endpoints. Each endpoint is designed to facilitate user interactions, manage system configurations, and retrieve essential data such as status, commands, values, devices, statistics, and logs. Whether you're a developer integrating with the API or a user exploring the functionality, this page serves as your resource for understanding how to effectively interact with the system. Explore the endpoints below to find the functionalities that best suit your needs.

HTTP Endpoint Structure Common

/common.css: Stylesheet for standard styling across all pages.
/common.js: JavaScript file for common functionalities shared among various endpoints.

Root

/: The landing page of the application, directing users to different sections.

Configuration

/config: Endpoint for managing configuration settings of the application.

Status

/status: Displays an overview of the system's health and operational status.
/api/v1/status: API endpoint to retrieve the system status in JSON format.

Commands

/commands: Main page for managing and viewing commands.
/api/v1/commands: API to fetch all registered commands.
/api/v1/commands/evaluate: Validates command inputs for structure and required fields.
/api/v1/commands/insert: Adds a new command to the command store.
/api/v1/commands/remove: Deletes a specific command from the command store.
/api/v1/commands/load: Loads commands into the command store from non-volatile storage.
/api/v1/commands/save: Saves all current commands back to non-volatile storage.
/api/v1/commands/wipe: Clears all commands from the command store.

Values

/values: Main page presenting stored values or commands.
/api/v1/values: Retrieves a JSON array of stored values including keys and units.
/api/v1/values/write: Writes a specified value using a stored command.
/api/v1/values/read: Reads the last stored value from the available data.

Devices

/devices: Overview page displaying information about connected devices.
/api/v1/devices: API that lists devices currently seen on the bus.
/api/v1/devices/scan: Initiates a scan for visible devices on the bus.
/api/v1/devices/scan/full: Performs a comprehensive scan of all potential slave addresses.
/api/v1/devices/scan/vendor: Executes a vendor-specific scan for targeted device detection.

Statistics

/statistics: Main page for visualizing and accessing collected statistical data.
/api/v1/statistics/counter: Retrieves counts of operational metrics like addresses and requests.
/api/v1/statistics/timing: Returns detailed timing statistics for performance monitoring.
/api/v1/statistics/reset: Resets all collected statistical data to zero for fresh analysis.

Logs

/logs: Displays log information to provide insights into system operations.
/api/v1/logs: Fetches log data, initially in plaintext, transitioning to JSON for structured output.

Restart

/restart: Endpoint to initiate a system restart for updates or maintenance.