API reference - Ricoh Theta

Set Access Point

	Definitions
Type	object

Description: Sets the access point information used in client mode. Up to five access points can be registered. If you set sixth access point, the oldest access point is deleted. The latest registered access point has a priority over others.

Service UUID	3c6feeb6-f335-4f93-a4bb-495f926db409
Characteristic UUID	4980acba-e2a5-460b-998b-9ad4c49fbe39
Value format	UTF-8 string (JSON)
Enabled to read	false
Enabled to write	true
Enabled to notify	false

Examples:

{
    "ssid": "ssid0123",
    "security": "WPA/WPA2 PSK",
    "password": "network security key"
}

{
    "ipAddressAllocation": "static",
    "ssid": "ssid0123",
    "security": "WPA/WPA2 PSK",
    "password": "network security key",
    "subnetMask": "255.255.255.0",
    "defaultGateway": "192.168.100.1",
    "ipAddress": "192.168.100.64"
}

Property	Type	Required	Description
ssid	string	yes	SSID
ssidStealth	boolean	no	True to enable SSID stealth
security	enum (of string)	no	Authentication mode. Required on initial registration. “none” is Theta X and Z1 only. “WPA3-SAE” is Theta A1 only.
password	string	no	Password. This can be set when security is not “none”.
connectionPriority	integer	no	Connection priority. Model Possible values Top priority Default value Theta A1 5 to 1 5 5 Theta X 1 An access point registered later has a higher priority 1 Theta Z1 1 to 5 1 1
ipAddressAllocation	enum (of string)	no	IP address allocation method. This can be acquired when SSID is registered as an enable access point.
ipAddress	string	no	IP address assigned to Theta. This setting must be set when “ipAddressAllocation” is “static”.
subnetMask	string	no	Subnet Mask. This setting must be set when “ipAddressAllocation” is “static”.
defaultGateway	string	no	Default Gateway. This setting must be set when “ipAddressAllocation” is “static”.
dns1	string	no	IP address of the first DNS server. Do not specify this property when ipAddressAllocation is dynamic.
dns2	string	no	IP address of the second DNS server. Do not specify this property when ipAddressAllocation is dynamic.
_proxy	object	no	Proxy information to be used for the access point.

ssid

	Definitions
Type	string

Description: SSID

Restrictions
Max length	32

ssidStealth

	Definitions
Type	boolean
Default	false

Description: True to enable SSID stealth

security

	Definitions
Type	enum (of string)

Description: Authentication mode. Required on initial registration. “none” is Theta X and Z1 only. “WPA3-SAE” is Theta A1 only.

Must be one of:

• “none”
• “WEP”
• “WPA/WPA2 PSK”
• “WPA3-SAE”

password

	Definitions
Type	string

Description: Password. This can be set when security is not “none”.

connectionPriority

	Definitions
Type	integer

Description: Connection priority.

Model	Possible values	Top priority	Default value
Theta A1	5 to 1	5	5
Theta X	1	An access point registered later has a higher priority	1
Theta Z1	1 to 5	1	1

	Restrictions
Minimum	≥ 1
Maximum	≤ 5

ipAddressAllocation

	Definitions
Type	enum (of string)
Default	"dynamic"

Description: IP address allocation method. This can be acquired when SSID is registered as an enable access point.

Must be one of:

• “dynamic”
• “static”

ipAddress

	Definitions
Type	string

Description: IP address assigned to Theta. This setting must be set when “ipAddressAllocation” is “static”.

subnetMask

	Definitions
Type	string

Description: Subnet Mask. This setting must be set when “ipAddressAllocation” is “static”.

defaultGateway

	Definitions
Type	string

Description: Default Gateway. This setting must be set when “ipAddressAllocation” is “static”.

dns1

	Definitions
Type	string

Description: IP address of the first DNS server. Do not specify this property when ipAddressAllocation is dynamic.

dns2

	Definitions
Type	string

Description: IP address of the second DNS server. Do not specify this property when ipAddressAllocation is dynamic.

_proxy

	Definitions
Type	object

Description: Proxy information to be used for the access point.

Property	Type	Required	Description
use	boolean	yes	Use proxy if true
url	string	no	Domain name or IP address of the proxy server
port	integer	no	Port number of the proxy server
userid	string	no	User ID used for proxy authentication
password	string	no	Password used for proxy authentication

use

	Definitions
Type	boolean

Description: Use proxy if true

url

	Definitions
Type	string

Description: Domain name or IP address of the proxy server

port

	Definitions
Type	integer

Description: Port number of the proxy server

	Restrictions
Minimum	≥ 1
Maximum	≤ 65535

userid

	Definitions
Type	string

Description: User ID used for proxy authentication

password

	Definitions
Type	string

Description: Password used for proxy authentication

---