設定用JSON

OS3.5.0以降

obnizOSが内部で利用しているJSONファイルで、このJSONをコンソールやクラウドから書き込むことでデバイスの設定を1回で行うことができます。

ネットワーク

キー名 タイプ 説明 必須
net string どのネットワークを利用するか指定します。複数ある場合は第一優先となります。 "wirelesslan"(wifi), "wifimesh", "wiredlan" "cellularmodule" 。 required
wifi Array of wifi Object ※1 配列の最後のものが一番新しく追加されたもの。OS3.5.0以前は配列の初めから試され、3.5.0以降は最後から試される。

注意: WiFiとcellularの両方が設定されている場合、netの値に関わらず常にLTE(cellularmodule)が先に試みられます。WiFiを優先することはできません。
|wifimesh|Array of wifimesh Object※2|オブジェクトの配列||
|ether|ether Object※3|"wiredlan"の設定||
|cellular|cellular Object※4|"cellularmodule"の設定||
|passkey|string|Wi-Fi経由設定のパスキー||
|wifi_channel|string|国/リージョン設定です。アクティブにスキャンする最大channelの設定||
|hw|Object|LEDといったコンポーネントなどハードウェアに関する設定||
|ws_server | string | ( OS7 or later )セルフホスティング利用時の接続先URL |

※1 wifi Object

キー名 タイプ 説明 必須 フォーマット/例
ssid string SSID required
pass string パスワード required
bssid string 接続先アクセスポイントのBSSID指定 HEX 6バイト。例) 0123456789ab
ip string 固定IP 例) 192.168.0.2
netmask string サブネットマスク 例) 255.255.255.0
gw string デフォルトゲートウェイ 例) 192.168.0.1
dns string DNS サーバー 例) 8.8.8.8
e_n string WPA2 Enterprise Username
e_p string WPA2 Enterprise Password
e_i string WPA2 Enterprise Identity/Anonymous ID
addr string プロキシ address
port string プロキシ port

※2 wifimesh Object

キー名 タイプ 説明 必須 フォーマット/例
ssid string SSID required
pass string Password required
meshid string Mesh ID required HEX 6バイト。例) 0123456789ab
bssid string 接続先アクセスポイントのBSSID指定 ステルスSSIDの場合は指定が必須となります HEX 6バイト。例) 0123456789ab
ip string 固定IP 例) 192.168.0.2
netmask string サブネットマスク 例) 255.255.255.0
gw string デフォルトゲートウェイ 例) 192.168.0.1
dns string DNS サーバー 例) 8.8.8.8
e_n string WPA2 Enterprise Username
e_p string WPA2 Enterprise Password
e_i string WPA2 Enterprise Identity/Anonymous ID
addr string WPA2 Proxy address
port string WPA2 Proxy port

※3 ether Object

キー名 タイプ 説明 必須 フォーマット/例
ip string 固定IP 例) 192.168.0.2
netmask string サブネットマスク 例) 255.255.255.0
gw string デフォルトゲートウェイ 例) 192.168.0.1
dns string DNS サーバー 例) 8.8.8.8
addr string WPA2 Proxy address
port string WPA2 Proxy port

※4 cellular Object

キー名 タイプ 説明 必須 フォーマット/例
apn string APN required
id string ID required
password string Password

passkey

Wi−Fi経由で設定を行う際のパスキーの設定です。
設定することで工場出荷時パスワードの"obniz"は利用できなくなります。

{
    "passkey": "newpasskey",
    "net": "wirelesslan",
    "wifi": [
        {
            "ssid": "your ssid",
            "pass": "your password"
        }
    ]
}

wifi_channel

Wi-Fiのリージョン/国設定です。何もなければ"11"が利用され、"11"は11chが最大のアクティブにスキャンする周波数となります。

選択できるものは以下となります。

  • "11": North America
  • "13": EU and Almost all the World
  • "14": Japan
{
    "wifi_channel": "13",
    "net": "wirelesslan",
    "wifi": [
        {
            "ssid": "your ssid",
            "pass": "your password"
        }
    ]
}

コンポーネント設定

システムコンポーネントの設定はhwで行うことができます。

以下の設定が可能です。

キー名 タイプ 説明 必須
terminal boolean ( OS7 or later ) Consoleを有効にするかどうかの指定です。Defaultではtrueとなっています。
setting_mode string ( OS7 or later ) "only_initial"を指定することでネットワークに繋がらない場合に自動的に設定モードにはいる機能をOFFにすることができます。

セルフホスティングにおける接続先サーバー

OS7以降ではobnizCloud以外のセルホスティングサーバーに接続することが可能です。
IPまたはドメイン名を利用し、Websocketプロトコルにて指定してください。

{
    "ws_server": "ws://192.168.0.2"
}
{
    "ws_server": "ws://192.168.0.2:8080"
}
{
    "ws_server": "ws://mydomain.com"
}

JSON 例

シンプルなWi-Fiの例

{
    "net": "wirelesslan",
    "wifi": [
        {
            "ssid": "your ssid",
            "pass": "your password"
        }
    ]
}

Wi-Fi 2設定と携帯回線で、携帯回線優先の例

{
    "net": "cellularmodule",
    "wifi": [
        {
            "ssid": "secondary wifi ssid",
            "pass": "your password"
        },
        {
            "ssid": "primary wifi ssid",
            "pass": "your password"
        }
    ],
    "cellular": {
        "apn": "apn1",
        "id": "id1",
        "password": "pass1"
    }
}

全項目のExample

{
    "net": "wirelesslan",
    "wifi": [
        {
            "ssid": "ssid1",
            "pass": "pass1",
            "bssid": "",
            "ip": "",
            "netmask": "",
            "gw": "",
            "dns": "",
            "e_n": "",
            "e_p": "",
            "e_i": "",
            "addr": "",
            "port": ""
        },
        {
            "ssid": "ssid2",
            "pass": "pass2",
            "bssid": "",
            "ip": "",
            "netmask": "",
            "gw": "",
            "dns": "",
            "e_n": "",
            "e_p": "",
            "e_i": "",
            "addr": "",
            "port": ""
        }
    ],
    "wifimesh": [{
        "ssid": "ssid1",
        "pass": "pass1",
        "bssid": "",
        "ip": "",
        "netmask": "",
        "gw": "",
        "dns": "",
        "e_n": "",
        "e_p": "",
        "e_i": "",
        "addr": "",
        "port": "",
        "meshid": "0123456789ab"
    }],
    "ether": {
        "ip": "",
        "netmask": "",
        "gw": "",
        "dns": "",
        "addr": "",
        "port": ""
    },
    "cellular": {
        "apn": "apn1",
        "id": "id1",
        "password": "pass1"
    },
    "hw": {
        "terminal": false,
        "setting_mode": "only_initial"
    },
    "ws_server": "ws://mydomain.com"
}