Soracom

1. サンプル実装と Orbit SDK リファレンスの AssemblyScript の内容を参考に、VS Code でソースコードを編集します。

   参考になるサンプル実装は、以下の 2 つです。

   • assembly/index.ts ファイル
   • WASM モジュール開発環境の orbit-sdk-assemblyscript/assembly/

   uplink() (デバイスから SORACOM に送信するデータを変換する関数) と、downlink() (データ送信先からデバイスに戻すデータを変換する関数) をエクスポートし、各関数にデータ変換処理を記述します。

   /**
    * process uplink (device -> SORACOM) message
    */
   export function uplink(): i32 {
     /* code  */
   }
   
   /**
    * process downlink (device <- SORACOM) message
    */
   export function downlink(): i32 {
     /* code */
   }
   

2. 以下のいずれかの方法で assembly/index.ts をコンパイルし、build/soralet.wasm を出力します。

   • NPM Scripts ビューを開き build スクリプトを実行する

     VS Code の Explorer を開き、[…] → [NPM Scripts] の順にクリックし、[NPM SCRIPTS] → [package.json] → [build] の [Run] をクリックします。

   • 統合ターミナルを開き npm run build コマンドを実行する

     VS Code で [Terminal] → [New Terminal] の順にクリックし、npm run build コマンドを実行します。

   • コマンドパレットを開き Tasks: Run Build Task を実行する

     VS Code で [View] → [Command Palette...] の順にクリックし、Tasks: Run Build Task をクリックします。

1. src/lib.rs ファイルにサンプル実装があります。サンプル実装の内容を参考に、VS Code でソースコードを編集します。

   なお、WASM モジュール開発環境の orbit-sdk-rust/examples/ にもサンプルがあります。

   uplink() (デバイスからクラウドへのデータを処理する) / downlink() (クラウドからデバイスへのデータを処理する) のいずれかまたは両方を pub 関数として定義してください。#[no_mangle] マクロをつけることで、Orbit の実行系がこのコードの uplink() / downlink() 関数を見つけることができるようになります。

   // For processing uplink (UE to SORACOM)
   #[no_mangle]
   pub fn uplink() -> i32 {
     /* code */
   }
   // For processing downlink (SORACOM to UE)
   #[no_mangle]
   pub fn downlink() -> i32 {
     /* code */
   }
   

2. 編集が完了したら以下のいずれかの方法で src/lib.rs を WASM にコンパイルします。結果は target/wasm32-unknown-unknown/debug/soralet.wasm に出力されます。コンパイルエラーが出た場合は適宜修正してください。

   • 統合ターミナルを開き cargo build コマンドを実行
   • コマンドパレット (⇧⌘P) から Run Build Task を実行
   • 上記のショートカット ⇧⌘B

1. src/main.cpp ファイルにサンプル実装があります。サンプル実装の内容を参考に、VS Code でソースコードを編集します。

   なお、WASM モジュール開発環境の orbit-sdk-c/examples/ にもサンプルがあります。

   uplink() (デバイスからクラウドへのデータを処理する) / downlink() (クラウドからデバイスへのデータを処理する) のいずれかまたは両方をエクスポートしてください。EMSCRIPTEN_KEEPALIVE マクロをつけて関数を宣言することで、コンパイラによる最適化を抑止し Orbit の実行系がこのコードの uplink() 関数を見つけることができるようになります。C++ を使う場合は extern "C" { ... } でこれらの関数を囲み、名前のマングル化を抑制してください。

   // For processing uplink (UE to SORACOM)
   EMSCRIPTEN_KEEPALIVE
   int32_t uplink()
   {
       return 0;
   }
   
   // For processing downlink (SORACOM to UE)
   EMSCRIPTEN_KEEPALIVE
   int32_t downlink()
   {
       return 0;
   }
   

2. 編集が完了したら以下のいずれかの方法で src/main.cpp を WASM にコンパイルします。結果は build/soralet.wasm に出力されます。コンパイルエラーが出た場合は適宜修正してください。

   • 統合ターミナルを開き make build コマンドを実行
   • コマンドパレット (⇧⌘P) から Run Build Task を実行
   • 上記のショートカット ⇧⌘B

   ビルド時に、Orbit が提供するいくつかの関数 (orbit_log orbit_get_input_buffer など orbit_ の接頭辞で始まる関数) のシンボルが未定義であるという警告が表示されますが、これは実行時に Orbit の処理系から提供される関数なのでコンパイル時に未定義でも問題ありません。

1. src/main.go ファイルにサンプル実装があります。サンプル実装の内容を参考に、VS Code でソースコードを編集します。

   なお、GitHub の orbit-sdk-tinygo の examples ディレクトリにもサンプルがあります。

   uplink() (デバイスからクラウドへのデータを処理する) / downlink() (クラウドからデバイスへのデータを処理する) のいずれかまたは両方を実装してください。それぞれの関数のコメント //export uplink|downlink でエクスポートされます。// の後に空白を入れないよう注意してください。

   import sdk github.com/soracom/orbit-sdk-tinygo
   
   // For processing uplink (UE to SORACOM)
   //export uplink
   func uplink() sdk.ErrorCode {
     sdk.Log("hello world, uplink")
     return 0
   }
   
   // For processing downlink (SORACOM to UE)
   //export downlink
   func downlink() sdk.ErrorCode {
     sdk.Log("hello world, downlink")
     return 0
   }
   

2. 編集が完了したら以下のいずれかの方法で src/main.go を WASM にコンパイルします。結果は build/soralet.wasm に出力されます。コンパイルエラーが出た場合は適宜修正してください。

   • 統合ターミナルを開き make build コマンドを実行
   • コマンドパレット (⇧⌘P) から Run Build Task を実行
   • 上記のショートカット ⇧⌘B

サンプルとして Jest を利用した スナップショットテスト を用意しています。スナップショットテストは、テスト対象の出力をスナップショットとして保存し、コードの変更によって出力に変更が生じたことを検出するテスト方式です。

1. tests/inputs.ts にテストケースを定義します。

   SoraletPayload[] に指定するオブジェクトの各プロパティは以下のとおりです。

   プロパティ	説明
   codeSrn	仮の SRN を指定します。変更しないでください。
   direction	uplink または downlink。処理するデータの送信方向を指定します。
   contentType	WASM モジュールが受け取るデータの種類を指定します。例: application/json
   body	WASM モジュールが受け取るデータを指定します。
   source.resourceType	データの送信元の種類を指定します。例: Subscriber
   source.resourceId	データの送信元を識別する ID を指定します。例: 440529999999950 (IMSI)
   tags	WASM モジュールが Orbit SDK を使って取得する IoT SIM のタグを指定します。name: "test1" と指定した場合は、name タグに値 test1 が設定されているようにテストが実行されます。
   location	WASM モジュールが Orbit SDK を使って取得する位置情報 (簡易位置測位機能 で取得した位置情報) を指定します。
   timestamp	Orbit がデータを受信したときのタイムスタンプ (UNIX 時間 (ミリ秒)) を指定します。

2. 以下のいずれかの方法で test スクリプトを実行します。

   • NPM Scripts ビューを開き test スクリプトを実行する

     VS Code の Explorer を開き、[…] → [NPM Scripts] の順にクリックし、[NPM SCRIPTS] → [package.json] → [test] の [Run] をクリックします。

   • 統合ターミナルを開き npm run test コマンドを実行する

     VS Code で [Terminal] → [New Terminal] の順にクリックし、npm run test コマンドを実行します。

   • コマンドパレットを開き Tasks: Run Test Task を実行する

     VS Code で [View] → [Command Palette...] の順にクリックし、Tasks: Run Test Task をクリックします。

   • デバッグを開始する (ただし、AssemblyScript にはブレイクポイントを設定できません)

     VS Code で [Run] → [Start Debugging] の順にクリックします。

3. WASM モジュールの実装を変更した結果、出力が変わり tests/__snapshots__/ ディレクトリのスナップショットとの差分が生じた場合は、エラーが発生します。意図した出力だった場合は、以下のいずれかの方法で test:updateSnapshot スクリプトを実行してスナップショットを更新します。

   • NPM Scripts ビューを開き test:updateSnapshot スクリプトを実行する

     VS Code の Explorer を開き、[…] → [NPM Scripts] の順にクリックし、[NPM SCRIPTS] → [package.json] → [test:updateSnapshot] の [Run] をクリックします。

   • 統合ターミナルを開き npm run test:updateSnapshot コマンドを実行する

     VS Code で [Terminal] → [New Terminal] の順にクリックし、npm run test:updateSnapshot コマンドを実行します。

現時点でテストのサンプルはありません。

各言語で提供するテスト機能やライブラリなどをご利用ください。

現時点でテストのサンプルはありません。

各言語で提供するテスト機能やライブラリなどをご利用ください。

現時点でテストのサンプルはありません。

各言語で提供するテスト機能やライブラリなどをご利用ください。