Home

さくらのモノプラットフォーム Client library for nRFConnect

さくらのモノプラットフォーム Client library for nRFConnect(モノプラライブラリ)は、さくらのモノプラットフォームとの通信を行うNordic社のnRF9160向けのクライアントライブラリです。

nRF9160のSDKであるnRFConnect SDKと併せて使用します。

バージョン一覧

確認済みの本ライブラリのバージョンと対応するnRFConnect SDKのバージョンの組み合わせは以下のとおりです。

ライブラリバージョン	nRFConnect SDKバージョン
v231030	v2.4.2
v230309	v2.2.0, v2.3.0
v221015	v1.7.1

サンプルプログラム

本ライブラリを使用したサンプルプログラムは以下の通りです。

v231031以降

サンプルプログラム集

対応モノプラライブラリ	サンプルプログラムバージョン
v231030	lib-v231030_00

v230309以前

オブジェクト送信

サンプルプログラムバージョン	nRFConnect SDKバージョン
v230310	v2.3.0
v220530	v1.7.1

オブジェクト受信

サンプルプログラムバージョン	nRFConnect SDKバージョン
v230310	v2.3.0
v220530	v1.7.1

ファイル送信

サンプルプログラムバージョン	nRFConnect SDKバージョン
v230315	v2.3.0

ファイル受信

サンプルプログラムバージョン	nRFConnect SDKバージョン
v230315	v2.3.0

サンプルプログラムは随時追加する予定です。

リファレンス

ディレクトリ構成

+- include
|   +- sipf
|        +- cert
+- src
+- zephyr

ディレクトリ	格納しているファイル
include/sipf	モノプラライブラリのヘッダファイル
include/sipf/cert	C言語文字列形式に変換したSSL/TLS接続に使用する自己署名認証局のルート証明書
src	モノプラライブラリのC言語ソースコード
zephyr	Zephyr OSモジュール定義ファイル

クライアントライブラリ

本ライブラリには、さくらのモノプラットフォームの以下の機能に対応したクライアントが含まれています。

• SIPF_AUTH: SIM(IPアドレス)認証クライアント
• SIPF_OBJECT: オブジェクト送受信クライアント
• SIPF_FILE: ファイル送受信クライアント

また、各クライアントが共通で使用する以下の機能がふくまれます。

• HTTPクライアント

プロジェクト設定パラメータ

Zephyr OSプロジェクトの設定ファイルprj.confで使用する設定パラメータは以下のとおりです。

パラメータ	説明	型	値	デフォルト
CONFIG_SIPF	モノプラライブラリ使用/不使用	bool	使用する場合はy、使用しない場合はn	n
CONFIG_SIPF_AUTH_HOST	SIPF_AUTHクライアントの接続先ホスト名	string		auth.sipf.iot.sakura.ad.jp
CONFIG_SIPF_AUTH_PATH	SIPF_AUTHクライアントのエントリポイントのパス名	string		/v0/session_key
CONFIG_SIPF_AUTH_DISABLE_SSL	SIPF_AUTHクライアントのSSL/TLSを無効にする	bool	無効にする場合はy、無効にしない場合はn	n
CONFIG_SIPF_CONNECTOR_HTTP_HOST	SIPF_OBJECTクライアントの接続先ホスト名	string		connector.sipf.iot.sakura.ad.jp
CONFIG_SIPF_CONNECTOR_PATH	SIPF_OBJECTクライアントのエントリポイントのパス名	string		/v0
CONFIG_SIPF_CONNECTOR_DISABLE_SSL	SIPF_OBJECTクライアントのSSL/TLSを無効にする	bool	無効にする場合はy、無効にしない場合はn	n
CONFIG_SIPF_FILE_REQ_URL_HOST	SIPF_FILEクライアントの接続先ホスト名	string		file.sipf.iot.sakura.ad.jp
CONFIG_SIPF_FILE_REQ_URL_PATH	SIPF_AUTHクライアントのエントリポイントのパス名	string		/v1/files/%s/