Overview

This guide aims to give you information and instructions about controlling your edelkrone devices over a PC.

In addition, this document also explains:

  • What is edelkrone SDK?

The edelkrone SDK is actually a daemon on your PC. It means that you should install it on your PC and run it in the background.

It provides an interface so that the edelkrone devices by can be managed by PC while running in the background. These interfaces are HTTP/REST API and WebSockets.

  • How does SDK connect to devices?

The connection is realized with Link Modules. Two types of Link Modules exist. The first is the edelkrone Stop Motion module, and the second is the Link adapter module. You can view them from here.

  • How to connect edelkrone devices and your application to each other

We assume that you have already completed the connections between your pc and edelkrone devices. The edelkrone SDK automatically scans link modules that are already plugged into your pc and then identifies them. If the connection is made successfully, SDK sends a notification to your OS notification system.

  • Which programming language should you use to communicate with the SDK?

You can use any programming language that supports HTTP and Websocket protocols.

  • RESTful API

The edelkrone SDK provides the REST API to users. The documentation can be reaching here

  • Limitations

There are varied limitations on connection, or your device combination cannot be feasible with your bundle setup. Also can check other restrictions from here

  • App configurations

You can configure some settings that edelkrone SDK has.

Also, this document explains the workflow of edelkrone SDK.