Cloud API

In addition to the graphical user interface (dashboard), the Coldwave system provides a powerful REST API. Using this API, the YUKI Module A1 can be queried, configured, and monitored programmatically. The API is ideal for custom software solutions, automation scripts, or integrations with existing systems.

The API offers, among others, the following functions:

• Authentication and session handling via token-based mechanisms
• Reading and writing properties of individual services of the module
• Subscribing to events in real time via WebSocket connection
• Schema queries to identify available services and data points

The data structure is clearly defined: A device consists of several services, each of which contains a set of properties. Each property has a type (e.g., BOOL, UINT16, STRING) and can be readable or writable depending on the configuration.

The full API documentation including example calls can be found here

Multi-user capability and data storage

Multiple user accounts in the Coldwave cloud can access the same module, provided the corresponding permissions are configured. This enables shared use and diagnostics by different roles (e.g., technicians, administrators).

The module internally buffers the last known state of the transmitted parameters. If the connection is interrupted, it automatically attempts to retransmit the last state once the connection is restored. A persistent history is stored exclusively in the cloud.

License and terms of use

The YUKI Module A1 contains proprietary software of ImagineOn GmbH, which may only be used within the scope of the functionality delivered with the product. Usage is limited to operating the module in conjunction with authorized devices and the Coldwave cloud platform. Redistribution, modification, or standalone execution of the software is not permitted.

In particular, the associated license prohibits:

• independent analysis or modification of the protocol stack,
• using the software on hardware components other than those intended for it,
• using the software without a valid cloud connection or outside the purposes explicitly approved for it.

For the complete license terms, see: Software Terms of Use ImagineOn