obniz Cloudに接続されたデバイスをAPIで操作します。APIは２つの方法で提供されています。
- Websocket - 双方向の通信が可能です
- REST API - デバイスへの一方的な通信が可能です
APIは共通のjsonフォーマットとなります。IOのオンオフからUART/SPI/BLEでの送受信などデバイスに関する全ての操作を行なえます。特にWebsocketAPIをHTMLから使えばハードウェアを双方向で簡単に操作可能です。
SDK
APIを操作するための複数のSDKが用意されています。
- obniz.js
Websocket APIを利用したJavaScript向けSDKです。すべての機能が利用でき、ブラウザ/Node.js 共に動作します。 Github: https://github.com/obniz/obniz - obniz-noble(非推奨)
Websocket APIを利用したBLE向けのSDKです、nobleをForkしており、すでにあるnobleのプロジェクトをそのままobnizのBLE経由に切り替えることが可能です。(注: 動作しますがメンテナンスしておりませんので、obniz.jsの使用を推奨します。) - obniz.py
Websocket APIを利用したPython向けSDKです。 - obniz-node-red
Websocket APIを利用したNode-RED向けSDKです。デバイスへの一方的な通信にのみ対応しております。
JSONフォーマット
IO・SPI・BLEなどAPIから利用可能な各機能は以下のリファレンスをご覧ください。