Endpoints - Functionality

The process and order of calls is nearly identical for all instruments. This ensures consistency and simplifies integration across different devices. Following a standardized sequence also makes it easier to debug, extend, and maintain the system over time.

The typical workflow follows these steps:

1. Lifecycle — Initialize The system is initialized and prepared for operation. This step sets up the environment, allocates necessary resources, and ensures the application is ready to interact with instruments.
2. Start a Device Scan The system performs a scan to discover available instruments. This ensures that only devices that are present, powered, and accessible are considered for connection.
3. Connect to Device Once a specific instrument is identified, you can establish a connection. At this point, communication channels are opened and verified.
4. Stop the Device Scan After a successful connection, scanning should be stopped to reduce resource usage and avoid unnecessary interference with the established session.
5. Trigger Measurements or Execute Commands The core functionality takes place here. Measurements can be triggered, data can be acquired, or commands can be executed depending on the device's capabilities and the needs of the workflow.
6. Disconnect from Device When all operations are completed, the instrument should be disconnected. This step ensures a clean release of resources and prevents potential conflicts with future connections.
7. Lifecycle — Shutdown The system is shut down gracefully. Resources are released, processes are closed, and the environment is returned to a safe, stable state.

Why This Process Matters

• Consistency: All instruments follow the same flow, which reduces the learning curve for developers.
• Reliability: Structured initialization and shutdown help prevent crashes and resource leaks.
• Scalability: Adding new instruments is easier when they fit into a standardized lifecycle.
• Debugging: Problems are easier to isolate when every session follows a predictable sequence.

Endpoint Reference

Cross-cutting topics relevant to every endpoint:

• Error Handling — uniform ErrorInfo response format and id.rhopointservice.com/E<n> reference URLs
• Security Notice — current authentication/transport posture and recommended deployment mitigations
• Measurement Image Formats — encoding of device images inside measurement containers (PNG / JPEG / raw)
• RAE File Format — binary layout of the measurement container

This lifecycle ensures that instruments are used efficiently, reliably, and in a way that can be repeated across multiple environments and use cases.