Songle Syncアプリを公開しよう

Songle Syncを使ったアプリが完成したら、公開してみんなに使ってもらいましょう。このページでは、そんなとき知っておくと便利なポイントや注意点、これまでチュートリアルでカバーしきれなかったIoT機器を使ったアプリ開発の方法などを紹介しています。

GitHubで公開する

Songle Syncを使ったプログラムを書くにあたって、サンプルコードは多ければ多いほど参考になります。AIST Songle Projectのリポジトリにもいくつかサンプルコードがありますが、まだまだ充実しているとはいえません。 プログラマのみなさまの利用例も、ぜひGitHubで公開するなどしてより多くの人と共有していただけると嬉しいです。

そんなときに参考にしていただきたいTipsをいくつかご紹介します。

1 サンプルプログラムをforkする

ここまで読んでいただいたみなさまはすでにされているかもしれませんが、何を作るか決めあぐねている場合は、まずAIST Songle Projectのリポジトリにあるサンプルプログラムをforkしてみてください。何かひらめくかもしれません。

サンプルプログラムはAIST Songle Project内で一番テストされていて、なおかつシンプルな構成になっています。ぜひ参考にしてみてください。

2 "songle-sync-" で始まるリポジトリ名にする

AIST Songle ProjectのGitHub上のサンプルプログラムはすべてsongle-sync- で始まるリポジトリに置くようにしています。

GitHubの検索フォームにそのキーワードを入力すると、プログラムが全て見つかるはずです。「songle-sync- の検索結果」を見てみてください。このリンクはチュートリアルやAIST Songle Projectのリポジトリにも載せてあるので、 他のSongle Syncユーザから見つけてもらいやすくなるはずです。 リポジトリ名に悩んだら、ぜひsongle-sync- で始まる名前にしてみてください。

3 "powered by Songle" ロゴを載せる

Songle Syncを使ったWebアプリには必ず次のようなロゴが小さく表示されています。リンク先はhttps://api.songle.jp です。

GitHubなどでソースコードを公開する場合も、このロゴ画像を自由に載せていただいて構いません。注意点は次のとおりです。

IoT機器でSongle Sync

1 ブラウザ版と同じAPI

Songle Syncは、Node.jsベースのインターネットに接続されたIoT機器で動作します。Webブラウザではapi.js をページに埋め込むことで動作しますが、Node.jsベースのIoT機器ではnpm install songle-api --save によってインストールされるsongle-api モジュールが全く同じAPIを提供します。

例えば次のように書けば動作します。（{access token}にはアクセストークンを入力）

var Songle = require('songle-api');
var player = new Songle.Player({
  accessToken: '{access token}'
});
player.addPlugin(new Songle.Plugin.SongleSync());
player.on("play", function (ev) { console.log("play"); });

2 動作確認済み機器の一覧

Songle SyncはJavaScriptで駆動できる以下のIoT機器で動作をテストしています。他の機器でも動いた・動かなかったという情報をTwitterかGitHub issues宛てにお寄せいただければ、確認のうえこちらに掲載します。

Rapiroで動作したことと、パソコン上のNode.jsで動作したことから、パソコンからArduinoなどのマイコンを遠隔操作するJohnny-Fiveのようなフレームワークでも問題なく動作するはずです。

なお、以下のIoT機器ではうまく動作しませんでした。主に処理能力の不足が原因だと考えられます。