API reference - Ricoh Theta

Get options response

	Definitions
Type	`object`

Description: Values of options requested. Response length is upto 512 bytes.

Examples:

{
    "userName": "THETAYR12345678",
    "captureMode": "image"
}

{
    "_defaultWifiPassword": "abcd1234"
}

Property	Type	Required	Description
_accessInfo	object	no	Option _accessInfo
_cameraPower	enum (of string)	no	Option _cameraPower
captureMode	enum (of string)	no	Option captureMode
_defaultWifiPassword	string	no	Option _defaultWifiPassword
_networkType	enum (of string)	no	Option _networkType
_ssid	string	no	Option _ssid
_username	string	no	Option _username
_wlanAntennaConfig	enum (of string)	no	Option _wlanAntennaConfig
_wlanFrequency	enum (of integer or number)	no	Option _wlanFrequency

_accessInfo

	Definitions
Type	`object`

Description: Information related to connected access point and/or client device around wireless LAN and/or 4G/LTE.
Read only.
Theta A1 and X only.

Examples:

{
    "defaultGateway": "192.168.1.1",
    "frequency": "2.4",
    "ipAddress": "192.168.1.3",
    "ssid": "rs500m-19c609-1",
    "subnetMask": "255.255.255.0",
    "proxyURL": "",
    "wlanSignalLevel": 1,
    "wlanSignalStrength": -64,
    "lteSignalLevel": 0,
    "lteSignalStrength": 0,
    "_dhcpLeaseAddress": []
}

{
    "defaultGateway": "",
    "frequency": "",
    "ipAddress": "",
    "ssid": "",
    "subnetMask": "",
    "proxyURL": "",
    "wlanSignalLevel": 0,
    "wlanSignalStrength": 0,
    "lteSignalLevel": 0,
    "lteSignalStrength": 0,
    "_dhcpLeaseAddress": [
        {
            "hostName": "A077295522",
            "ipAddress": "192.168.1.5",
            "macAddress": "3c:21:9c:f0:39:c1"
        }
    ]
}

Property	Type	Required	Description
defaultGateway	string	yes	IP address of default gateway in CL mode
frequency	string	yes	Radio frequency in CL mode, e.g. 2.4 5.2
ipAddress	string	yes	IP address of Theta in CL mode
proxyURL	string	yes	IP address of proxy server in CL mode
ssid	string	yes	SSID of the wireless LAN access point that THETA connects to in CL mode
subnetMask	string	yes	Subnet mask of wireless LAN in CL mode
dns1	string	no	IP address of the first DNS server in CL mode
dns2	string	no	IP address of the second DNS server in CL mode
wlanSignalStrength	integer	yes	Wireless LAN signal strength in dBm in CL mode
wlanSignalLevel	integer	yes	Wireless LAN signal level in CL mode
lteSignalStrength	integer	yes	LTE signal strength in dBm
lteSignalLevel	integer	yes	LTE signal level
_dhcpLeaseAddress	array	yes	Client devices information in AP mode

defaultGateway

	Definitions
Type	`string`

Description: IP address of default gateway in CL mode

frequency

	Definitions
Type	`string`

Description: Radio frequency in CL mode, e.g. 2.4 5.2

ipAddress

	Definitions
Type	`string`

Description: IP address of Theta in CL mode

proxyURL

	Definitions
Type	`string`

Description: IP address of proxy server in CL mode

ssid

	Definitions
Type	`string`

Description: SSID of the wireless LAN access point that THETA connects to in CL mode

subnetMask

	Definitions
Type	`string`

Description: Subnet mask of wireless LAN in CL mode

dns1

	Definitions
Type	`string`

Description: IP address of the first DNS server in CL mode

dns2

	Definitions
Type	`string`

Description: IP address of the second DNS server in CL mode

wlanSignalStrength

	Definitions
Type	`integer`

Description: Wireless LAN signal strength in dBm in CL mode

wlanSignalLevel

	Definitions
Type	`integer`

Description: Wireless LAN signal level in CL mode

	Restrictions
Minimum	≥ 0
Maximum	≤ 4

lteSignalStrength

	Definitions
Type	`integer`

Description: LTE signal strength in dBm

lteSignalLevel

	Definitions
Type	`integer`

Description: LTE signal level

	Restrictions
Minimum	≥ 0
Maximum	≤ 4

_dhcpLeaseAddress

	Definitions
Type	`array`

Description: Client devices information in AP mode

	Array restrictions
Min items	N/A
Max items	N/A

Each item of this array must be	Description
dhcpLeaseAddress	Client device information

dhcpLeaseAddress

	Definitions
Type	`object`

Description: Client device information

Property	Type	Required	Description
hostName	string	no	Host name of client device
ipAddress	string	yes	IP address of client device
macAddress	string	yes	MAC address of client device

hostName

	Definitions
Type	`string`

Description: Host name of client device

ipAddress

	Definitions
Type	`string`

Description: IP address of client device

macAddress

	Definitions
Type	`string`

Description: MAC address of client device

_cameraPower

	Definitions
Type	`enum (of string)`

Description: The power status of the camera.
Theta A1 and X only.

off: Power off
on: Power on
sleep: Power on, sleep mode
powerSaving: Power on, power saving mode. Camera is closed. This value can not set when plugin is running. In that case, invalidParameterValue error will be returned.
silentMode: Power on, silent mode. LCD/LED is turned off. Theta X only. This value can not set when plugin is running. In that case, invalidParameterValue error will be returned.

Must be one of:

“off”
“on”
“sleep”
“powerSaving”
“silentMode”

captureMode

	Definitions
Type	`enum (of string)`

Description: Shooting mode.
Swithcing modes may take time. Wait a while to send the command that takes place after switching the mode.

image: Still image capture mode
video: Video capture mode

Must be one of:

“image”
“video”

_defaultWifiPassword

	Definitions
Type	`string`

Description: Initial WLAN password for AP mode.
Read only.

Restrictions
Min length	8
Max length	8

_networkType

	Definitions
Type	`enum (of string)`

Description: Current network type.

AP: Direct mode
CL: Client mode
OFF: Network is off. This value can be gotten only by a plugin or BLE API.
ETHERNET: Client mode via Ethernet cable. This value cannot be set.
LTE *: LTE is connected. Can not set these values. Theta A1 only.

Must be one of:

“AP”
“CL”
“OFF”
“ETHERNET”
“LTE plan-D”
“LTE plan-DU”
“LTE plan01s”
“LTE planX3”
“LTE planP1”
“LTE plan-K2”
“LTE plan-K”

_ssid

	Definitions
Type	`string`

Description: SSID of Theta. It must end with “.OSC”. This option can be get and set during the direct mode.

Restrictions
Min length	5
Max length	24
Must match regular expression	`.*\.OSC$` Test

_username

	Definitions
Type	`string`

Description: Username used for digest authentication when connecting to Theta in the client mode. The default username is a concatenation of THETA and its serial number (e.g., THETAYR12345678).
This option can be set during the direct mode.

_wlanAntennaConfig

	Definitions
Type	`enum (of string)`

Description: Configure the wireless antenna to operate in either SISO or MIMO mode. This option can be set when Theta is in AP mode. After changing the settings, required reboot THETA to apply the changes.
Theta A1 and X only.

SISO: Single Input Single Output. Priority on power saving.
MIMO: Multiple Input Multiple Output. Priority on wireless speed.

Must be one of:

“SISO”
“MIMO”

_wlanFrequency

	Definitions
Type	`enum (of integer or number)`

Description: Wireless LAN frequency of Theta in the direct mode.

2.4: 2.4GHz
5: 5GHz (5.2GHz to be exact). Theta X and Z1 only.
Note that availability of 5GHz depends on the destination setting. Check for the standard in the target region before using this option.
5.2: 5.2 GHz. Theta A1 only.
Note that availability of 5.2GHz depends on the destination setting. Check for the standard in the target region before using this option.
5.8: 5.8GHz. Theta A1 only.
Note that availability of 5.8GHz depends on the destination setting. Check for the standard in the target region before using this option.

Must be one of: