You can export/import device information csv.
CSV Export
Only devices shown at device management page will be exported. The number of devices may vary depending on your searching conditions. There are two CSV formats: "one printed normal device information" and "one printed app installation information".
CSV Layout
Normal Device Information
| Name | Description | Required |
|---|---|---|
| id | Device ID | ✅ |
| access_token | Access Token | |
| hardware | Name of Hardware | ✅ |
| description | Description of a device. This includes in metadata, too | |
| metadata | Meta data | |
| devicekey | Device key | ✅ |
| os | Kind of OS installed on a device | ✅ |
| osVersion | Version of OS installed on a device | ✅ |
| region | Location of a server to which a device connects | ✅ |
| status | Status of device's activeness | ✅ |
| wifi_mac_address | MAC address of Wifi | |
| ether_mac_address | Mac address of Ethernet | |
| pingInterval | Online Check Interval | |
| createdAt | Date when a device is registered | ✅ |
App Installation Information
This is the format friendly with CSV import(We mention about this below this page). If you wish to export a CSV in this format, it's required that you've searched devices before and app id contains in searching conditions. From app to app, options required at installation time are different. We want to keep the CSV layout, or say, the number of column consistent.
| Name | Description | Available values |
|---|---|---|
| obniz.id | Device ID | 0000-0000 format |
| obniz.metadata.description | Description of a device | |
| obniz.activate_status | Status of a device | active / inactive |
| obniz.online_check_interval | Online Check Interval | 1 ~ 30 |
| obniz.notification.offline.enable | Enable/Disable offline notification | enable / disable |
| obniz.notification.offline.add_issue | Whether or not to make it an issue when offline is detected | enable / disable |
| install_app[0].id | App ID installed on a device | wa_xxx |
| install_app[0].configs.xxx | Option values required for app installation. xxx must match option key. |
※Different app has different number of options required at installation time.
Exaple follows.
Temperature Measuring app that needs options of a temperature to send notification(temperature_limit) and notification way(notification_way)
| Name | Description | Available values |
|---|---|---|
| obniz.id | Device ID | 0000-0000 format |
| obniz.metadata.description | Description of a device | |
| obniz.activate_status | Status of a device | active / inactive |
| obniz.online_check_interval | Online Check Interval | 1 ~ 30 |
| obniz.notification.offline.enable | Enable/Disable offline notification | enable / disable |
| obniz.notification.offline.add_issue | Whether or not to make it an issue when offline is detected | enable / disable |
| install_app[0].id | App ID installed on a device | wa_xxx |
| install_app[0].configs.temperature_limit | Temperature to send notification | |
| install_app[0].configs.notification_way | Notification way |
Sample toy app made by your seven year old nephew that takes no options
| Name | Description | Available values |
|---|---|---|
| obniz.id | Device ID | 0000-0000 format |
| obniz.metadata.description | Description of a device | |
| obniz.activate_status | Status of a device | active / inactive |
| obniz.online_check_interval | Online Check Interval | 1 ~ 30 |
| obniz.notification.offline.enable | Enable/Disable offline notification | enable / disable |
| obniz.notification.offline.add_issue | Whether or not to make it an issue when offline is detected | enable / disable |
| install_app[0].id | App ID installed on a device | wa_xxx |
CSV Import
You can install an app to multiple devices by one single csv import operation. Installation acts like a 'registration' for a device that's not been installed any app and 'updation' for a device that's already installed the very app you're just intending to install. Options that's required at installation time differ from app to app, so before carring out CSV import it's recommended to search devices by conditions including app id and export them as an app information CSV. You can use this CSV to import.
CSV Layout
You can use the csv exported in the "Apps with installation information" section without modification.
Please use Shift_JIS character encoding.
| Name | Description | Available values | Required |
|---|---|---|---|
| obniz.id | Device ID | 0000-0000 format | ✅ |
| obniz.metadata.description | Description of a device | ✅ | |
| obniz.activate_status | Status of a device | active / inactive | |
| obniz.online_check_interval | Online Check Interval | 1 ~ 30 | |
| obniz.notification.offline.enable | Enable/Disable offline notification | enable / disable | |
| obniz.notification.offline.add_issue | Whether or not to make it an issue when offline is detected | enable / disable | |
| install_app[0].id | App ID installed on a device | wa_xxx | ✅ |
| install_app[0].configs.xxx | Option values required for app installation. xxx must match option key. |