Managing Cambrionix APIs in Connect
Cambrionix APIs provide the backbone for seamless interaction between your devices and the Cambrionix Connect platform, offering comprehensive control and monitoring capabilities. This overview dives into the functionalities of the Cambrionix APIs, essential for efficient device management and operations.
Types of Cambrionix APIs
- Hub API: Enables direct communication with Cambrionix hubs, allowing for the management of ports, monitoring of connected devices, and execution of specific hub commands.
- Recorder API: Designed for accessing historical data and analytics. It captures detailed information on device charging patterns, health statistics, and usage trends over time.
API Functionality
The Cambrionix APIs facilitate direct communication and control over your Cambrionix hubs and connected devices. Users can execute commands to manage device charging, access port information, update firmware, and retrieve device health data. These capabilities enable automated management processes and integration with custom applications for enhanced operational efficiency.
API Status Indicators
Understanding the status of your API connection is crucial for maintaining seamless operations. Cambrionix Connect provides clear indicators of API status, represented by colour codes:
- Green: API is connected and functioning correctly, with all features available for use.
- Orange: API is connected, but some features may not be available due to license restrictions or other limitations.
- Red: API is not connected, requiring troubleshooting to restore full functionality.
API Status Table
| Status | Description |
|---|---|
| Local | The API is visible and connected using a local network connection. |
| Activated | The API is connected through a secure SSL connection, indicating optimal operation. |
| Deactivated | The API is restricted to local network connections due to deactivation on the host computer. |
Individual API Settings
"Individual API Settings" offer advanced configuration options for customized communication between Cambrionix hardware and the Connect platform. The following table provides an overview:
| Name | Description |
|---|---|
| Computer Name | Identifies the host computer within Cambrionix Connect, allowing for customized naming. |
| Address | Specifies the network address of the API, supporting targeted API requests. |
| Port | The network port for API communications, ensuring secure and reliable connectivity. |
* After changing any settings, click the save button to retain them; otherwise, they will revert to defaults.
Battery Services
Battery Services within the Cambrionix API provide insights into device health and charging patterns. When iTunes (for Apple devices) or an adb server (for Android devices) is operational, users can access battery data, including charge levels, charging cycles, and battery health.
API Logging
API Logging captures all USB events and interactions, providing detailed logs for troubleshooting and monitoring. Logs can be exported for review and are useful for diagnosing issues or understanding device behaviour. Our Support team may request these logs for assistance.
Best Practices for API Management
- Regular Monitoring: Keep track of API status indicators to ensure connectivity.
- Update and Maintenance: Keep hardware and software updated for stability and access to features.
- Security Practices: Use SSL for encrypted communications and review access controls regularly.
Support
For more details on using the Cambrionix APIs or for assistance with connectivity, consult the Cambrionix Connect User Manual or contact our Support team.