We’ve mentioned in the past that we’re working on an API to allow developers to link their own tools to the Electric Imp platform and so use those tools instead of the online IDE. I’m pleased to announce that the API, called Build, is now being opened to forum members for beta testing after a short closed beta test period.
Virtually any task that you can currently perform with the IDE, can be performed using the Electric Imp Build API. For example, Build provides a way to list the models you’ve created and any devices associated with them. Devices can be moved from model to model, their human-friendly names changed, or placed in an unassigned state. Device logs can be downloaded for inspection, and streamed to you as they are posted. New models can be created, old one deleted. Agent and device code can be uploaded, and older versions accessed. Devices can be restarted.
You might use Build to create your own desktop IDE using your computer’s native language and SDK, or a cross-platform tool like Java. Alternatively, you can use Build as the basis for a plug-in to be loaded by your favorite text editor. In each case, you can develop code offline and keep your source files locally, or on your own server. This in turn facilitates easier collaborative coding.
You can find full documentation for Build here: electricimp.com/docs/buildapi/.
To make use of Build, you will require an API key to authorize your calls. You can request your key by emailing email@example.com and providing your Electric Imp account name. You’ll then get a message from firstname.lastname@example.org containing a link to onetimesecret.com – follow the link to retrieve your key.
If you’re testing Build alongside the IDE, you should note that changes made using Build will be reflected in the IDE, however it may be necessary to refresh the browser in which the IDE is being viewed if, for instance, it is showing a model that is also being modified via the API.
Build’s scope is currently restricted to actions performed using the IDE for software development.
The Electric Imp Build API is currently being made available in a pre-release form for testing and evaluation, and to gain feedback from trusted developers. As such, it should NOT be used with code that is business or project critical. You should also be aware that Build’s endpoints and properties may change before final release.
Please post any feedback you have – we want to hear your thoughts on the API’s details as well as an issues you are having – below.
And let us know what tools you end up using with Build.