Usage : srp client [command] ...
Usage: srp client help
Print SRP client help menu.
> srp client help autostart callback help host keyleaseinterval leaseinterval service start state stop ttl Done
Usage srp client autostart [enable|disable]
Enable/Disable auto start mode in SRP client. This command requires OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_API_ENABLE feature to be enabled.
Get the current autostart mode.
> srp client autostart Disabled Done
Set the autostart mode.
> srp client autostart enable Done > srp client autostart Enabled Done
Usage srp client callback [enable|disable]
Enable/Disable printing callback events from SRP client.
Get current callback mode
> srp client callback Disabled Done
Set callback mode
> srp client callback enable Done > srp client callback Enabled Done
When two services are successfully registered:
SRP client callback - error:OK Host info: name:"dev4312", state:Registered, addrs:[fd00:0:0:0:0:0:0:1] Service list: instance:"ins2", name:"_test2._udp", state:Registered, port:111, priority:1, weight:1 instance:"ins1", name:"_test1._udp,_sub1,_sub2", state:Registered, port:777, priority:0, weight:0
When service ins2 is removed:
SRP client callback - error:OK Host info: name:"dev4312", state:Registered, addrs:[fd00:0:0:0:0:0:0:1] Service list: instance:"ins1", name:"_test1._udp", state:Registered, port:777, priority:0, weight:0 Removed service list: instance:"ins2", name:"_test2._udp,_sub1,_sub2", state:Removed, port:111, priority:1, weight:1
When host info (and all services) is removed:
SRP client callback - error:OK Host info: name:"dev4312", state:Removed, addrs:[fd00:0:0:0:0:0:0:1] Service list: Removed service list: instance:"ins1", name:"_test1._udp", state:Removed, port:777, priority:0, weight:0
Usage: srp client host
Print the full host info (host name, state, list of host addresses).
> srp client host name:"dev4312", state:Registered, addrs:[fd00:0:0:0:0:0:0:1234, fd00:0:0:0:0:0:0:beef] Done
When auto host address mode is enabled.
srp client host name:"dev1234", state:Registered, addrs:auto Done
Usage: srp client host name [name]
Get the host name.
> srp client host name dev4312 Done
Set host name (can be set when the host is removed or not yet registered with server).
srp client host name dev4312 Done
Usage : srp client host address [auto | <address> ...]
Indicate auto address mode is enabled.
> srp client host address auto Done
Get the list of host addresses (when auto host address is not enabled).
> srp client host address fd00:0:0:0:0:0:0:1234 fd00:0:0:0:0:0:0:beef Done
Enable auto host address mode. When enabled client will automatically use all preferred Thread netif unicast addresses excluding all link-local and mesh-local addresses. If there is no preferred address, then Mesh Local EID address is added. SRP client will automatically re-register if/when addresses on Thread netif get changed (e.g., new address is added or existing address is removed or marked as non-preferred).
> srp client host address auto Done
Explicitly set the list of host addresses (can be set while client is running to update the host addresses), also disabled auto host address mode.
> srp client host address fd00::cafe Done
Usage: srp client host state
Get the host state.
> srp client host state Registered Done
The possible states are (same value for service state):
ToAdd: item to be added/registered.Adding: item is being added/registered.ToRefresh: item to be refreshed (renew lease).Refreshing: item is being refreshed.ToRemove: item to be removed.Removing: item is being removed.Registered: item is registered with server.Removed: item is removed.Usage: srp client host remove [removekeylease] [sendunregtoserver]
Remove host info and all services from server.
removekeylease is an optional boolean value indicating whether or not the host key lease should also be removed (default is false).sendunregtoserver is a another optional boolean value indicating whether or not to send an update message to the server when host info is not yet registered (default is false).> srp client host remove 1 Done
Usage: srp client host clear
Clear host info and all services on client (unlike host remove, with host clear no update is sent to server).
> srp client host clear Done
Usage: srp client keyleaseinterval [interval]
Get the key lease interval (in seconds).
> srp client keyleaseinterval 1209600 Done >
Set the key lease interval.
> srp client keyleaseinterval 864000 Done
Usage: srp client leaseinterval [interval]
Get the lease interval (in seconds).
> srp client leaseinterval 7200 Done >
Set the lease interval.
> srp client leaseinterval 3600 Done
Usage: srp client server
Print the server socket address (IPv6 address and port number).
> srp client server [fd00:0:0:0:d88a:618b:384d:e760]:4724 Done
Print the server IPv6 address.
> srp client server address fd00:0:0:0:d88a:618b:384d:e760 Done
Print the server port number
> srp client server port 4724 Done
Usage: srp client service
Print the list of services.
> srp client service instance:"ins2", name:"_test2._udp,_sub1,_sub2", state:Registered, port:111, priority:1, weight:1 instance:"ins1", name:"_test1._udp", state:Registered, port:777, priority:0, weight:0 Done
Usage: srp client service add <instancename> <servicename> <port> [priority] [weight] [txt]
Add a service with a given instance name, service name, port number, priority, weight and txt values.
The <servicename> can optionally include a list of service subtype labels separated by comma.
The priority and weight are optional and if not provided zero will be used. The txt should follow hex-string format and is treated as an already encoded TXT data byte sequence. It is also optional and if not provided it is considered empty.
> srp client service add ins1 _test1._udp 777 Done > srp client service add ins2 _test2._udp,_sub1,_sub2 111 1 1 Done
Usage: srp client service remove <instancename> <servicename>
Remove a service with a give instance name and service name.
> srp client service remove ins2 _test2._udp Done
Usage: srp client service clear <instancename> <servicename>
Clear a service with a give instance name and service name (unlike service remove, with service clear no update is sent to server and the entry is immediately removed from client list).
> srp client service clear ins2 _test2._udp Done
Usage srp client service key [enable|disable]
Enable/Disable “service key record inclusion” mode in SRP client. This command requires OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE feature to be enabled.
KEY record is optional in Service Description Instruction (it is required and always included in the Host Description Instruction). The default behavior of SRP client is to not include it. This command is intended to override the default behavior for testing only (in a REFERENCE_DEVICE build).
Get the current “service key record inclusion” mode.
> srp client service key Disabled Done
Set the “service key record inclusion” mode.
> srp client service key enable Done > srp client service key Enabled Done
Usage: srp client start <serveraddr> <serverport>
Start the SRP client with a given server IPv6 address and port number.
> srp client start fd00::d88a:618b:384d:e760 4724 Done
Usage: srp client state
Indicates the state of SRP client, i.e., whether it is enabled or disabled.
> srp client state Enabled Done
Usage: srp client stop
Stop the SRP client.
> srp client stop Done
Usage: srp client ttl [value]
Get the TTL (in seconds).
> srp client ttl 7200 Done >
Set the TTL.
> srp client ttl 3600 Done