Managing Cambrionix APIs in Connect
Introduction
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.
Cambrionix provides two main types of 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 are designed to facilitate direct communication and control over your Cambrionix hubs and connected devices. Through these APIs, users can execute commands to manage device charging, access port information, update firmware, and retrieve device health data, among other tasks. These capabilities enable automated management processes and integration with custom applications for enhanced operational efficiency. The Cambrionix Hub API is essential for the Cambrionix Connect desktop application.
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 and descriptions, ensuring users can quickly assess and address connectivity and operational statuses.
Status Colour Descriptions:
- Green: Indicates the API is connected and functioning correctly, with all features available for use.
- Orange: Indicates the API is connected but some features may not be available due to license restrictions or other limitations.
- Red: Indicates the API is not connected, necessitating troubleshooting to restore full functionality.
API Status Table:
The following table provides a detailed explanation of the various API statuses you may encounter:
| Status | Description |
|---|---|
| Local | The API is visible and connected using a local network connection. |
| Activated | The API is visible and connected through a secure SSL connection, indicating optimal operation. |
| Deactivated | Indicates the host computer has deactivated the API, restricting it to local network connections. |
Individual API Settings
For users seeking a deeper level of customisation and control over their Cambrionix Connect experience, the "Individual API Settings" offer an array of options. These settings allow for tailored configurations, ensuring that the communication between the Cambrionix hardware and the Connect platform is both secure and efficient. Below is a detailed table that outlines the available individual API settings, providing clarity on each option's purpose and application.
| Name | Description |
|---|---|
| Computer Name | The name assigned to the host computer within the Cambrionix Connect platform. This name is used for identification and may be customised for easier recognition. |
| Address | Specifies the network address of the API service. This can be an IP address or a fully qualified domain name, enabling precise targeting for API requests. |
| Port | The network port used for API communications. This setting ensures that API requests are sent to and received from the correct network port, supporting secure and reliable connectivity. |
*Once you have altered any of these settings, ensure you press the save button or they will revert to their default values.
Battery Services
Battery Services within the Cambrionix API provide detailed insights into the health and charging patterns of connected devices. When iTunes (for apple devices) or an adb server (for android devices) is operational on the host system, users can access critical battery information, including charge levels, charging cycles, and overall battery health. This data is instrumental in proactively managing device longevity and ensuring devices are charged efficiently. Users can configure battery service settings to adjust the frequency of battery information updates, optimising the balance between real-time monitoring and system resource utilisation.
API Logging
API Logging is a crucial feature for troubleshooting and monitoring the health of the API connections. The Cambrionix API can generate detailed logs of all USB events and interactions, capturing a comprehensive record of actions, errors, and system messages. This feature is invaluable for diagnosing issues, understanding device behaviour, and ensuring smooth operation of the API services. Logs can be easily exported and reviewed. Our Support team may ask for these logs if issues arise that require support.
Best Practices for API Management
- Regular Monitoring: Keep an eye on the API status indicators within Cambrionix Connect to ensure ongoing connectivity and functionality.
- Update and Maintenance: Ensure your Cambrionix hardware and Connect platform are regularly updated to the latest versions to support API stability and access to new features.
- Security Practices: Secure your API connections by adhering to best practices, including the use of SSL for encrypted communications and regular reviews of access controls and permissions.
Support
For further details on leveraging the Cambrionix APIs or assistance with connectivity and operational issues, please refer to the Cambrionix Connect User Manual or reach out to our Support team for guidance and support.