STBremoteconf
STBremoteconf is operated by entering commands with the following syntax:
./STBremoteconf [-p <product_list>] [-e <expiry>] [-P <port>] <host> ./STBremoteconf [-p <product_list>] [-e <expiry>] [-P <port>] <host> mand_optio
mand_options [<paramens [<parameters>...]>ters>...]>
Alternatively, you can enter the command./STBremoteconf./STBremoteconf without any arguments to display help at the command line.
If you have copied theSTBremoteconfSTBremoteconf to a directory in the system path (for example,/usr/bin/usr/bin), you can enter the commands without the ././ at the start.
A
Arrgguummeenntt UUssaaggee -p <product_list>
-p <product_list> A comma-separated list of product codes that you want the command to apply to. For example:
-p 140,140H
(cannot be used in conjunction with -m or -s) -e <expiry>
-e <expiry> Time at which the message will expire. If you do not include this argument, it defaults to 30 seconds from the current time.
The time specified should be acceptable to the ParseDate
ParseDate Perl command. For example:
"todaytoday"
"1st Thursday in June 20081st Thursday in June 2008"
"05/10/0705/10/07"
"12:30 Dec 12th 1880
"12:30 Dec 12th 1880"
"8:00pm December tenth"
"8:00pm December tenth"
-P <port>
-P <port> Port to send the command on.
For unicast, the default port is5432154321. For multicast, the default port is2222222222.
<host>
<host> Thehosthost argument that specifies where the command will be sent or enables you to save the command for use later. See below for more information.
-m
-m optional mac address in format 00:02:02:xx:xx:xx
(cannot be used in conjunction with -s or -p). A maximum of five STBs can be contacted using MAC addresses.
<command_options
<command_options [<parameters>...]>
[<parameters>...]>
The command that will be executed (see
<command_options> argument) -t
-t optional TTL value for multicast (defaults to 10).
-s
-s optional serial number (cannot be used in
conjunction with -m or -p).
-u
-u optional UDP response timeout (number 1-999)
(defaults to 10).
USING STBREMOTECONF
3.5.1 <host> argument
The<host><host> argument must be included in all commands. It can be set with one of the following values, depending on where you want the command to be sent:
<multicast_group>
<multicast_group>
To send the command to all STBs listening on a particular multicast group, enter the IP address of the group (for example, as defined in the configuration of the STB or the DHCP server configuration). If no group has been configured on the STB, the default address225.10.10.10225.10.10.10 is used.
Use the multicast option with care to ensure that you are sending the command to the multicast group you have specified.
<unicast_IPaddress>
<unicast_IPaddress>
To send the command to a single STB listening on the network, enter the IP address for that box. Alternatively, you can enter a valid name (which has a DNS entry). You should send commands to a single box in this way if you want to configure settings for a single box, or if the command returns information such as status or version.
If the IP address is invalid, then the following error is returned:
Couldn’t convert to internet address: Resource temporarily unavailable.
Couldn’t convert to internet address: Resource temporarily unavailable.
If the IP address is valid, but the STB does not respond to the command (for example, the STB is not connected or the address has not been allocated by the DHCP server), then the following error is returned:
Couldn’t connect: Connection refused Couldn’t connect: Connection refused
3.5.2 Save
To sign a command and save it for multicasting or unicasting later, replace<host><host> withSAVESAVE. This is useful as it allows you to collect multiple signed commands together to be transmitted altogether later, or to give a signed command to a third party that it is not appropriate to give keys to.
STBremoteconf
STBremoteconf saves the signed command to aSAVEFILE.msgSAVEFILE.msg file in the current directory, and you can send it later using theSIGNEDCMDSIGNEDCMD command option.
Although theSAVESAVE command can be used to create a batch of multicast or unicast commands, the expiry time from when the command is signed still applies (default is 30 seconds). This means that each command must be multicast/unicas t before its expiry time is reached. The-e-e parameter can be used to specify a longer expiry time.
For example:
STBremoteconf -e "December 16th 2009" SAVE REBOOT STBremoteconf -e "December 16th 2009" SAVE REBOOT
3.5.3 <command_options> argument
The<command_options><command_options> argument must be included in all commands, and specifies the operation you want to execute. Some options also require additional parameters. SeeOverview of command options for a list of available options.
USING STBREMOTECONF
3.5.4 Overview of command options
You can add one of the following to theSTBremoteconfSTBremoteconf command. Alternatively, enter the command without adding any options to viewSTBremoteconfSTBremoteconf version information and a full list of available commands at the command line (see the full command list for details of when they should be used). You should only use these if you are fully aware of the implications for your STB
Not all commands will give a response.
C
Coommmmaanndd UssaUaggee
CEC_TVON Switches on the TV using CEC*
CEC_TVOFF Switches off the TV using CEC*
CEC_CMD Sends a CEC command*
*See the Amino JMACX API specification (AM-000502-TC) for more information about CEC commands.
CHANGEPAGE <url> <url> Displays the page specified on the STB browser.
DUMPCONFIG<location to store<location to store output file> <optional prefix>
output file> <optional prefix>
Requests a dump of the libconfig settings.
EAS <message> <message> Sends an EAS (Emergency Alert System) message.
ETHERNET <value> <value> Sets the Ethernet speed.
GETCONFIG seeSETCONFIG Allows a key defined by libconfig (seeUsing libconfig to get and set values) to be obtained.
GETDI Returns the deployment index.
GETSTAT Returns STB statistics (not currently supported on
x0xx series STBs).
GETVERSION Returns the current software version on the STB.
HWINFO Returns information about the STB hardware.
LOGREAD Returns last few entries from syslog.
OUTFMT <format><format> Sets the output format of the STB.
OUTRES Sets the output resolution. (HD-capable boxes
only) PING <remote_host> <count> <remote_host> <count>
<backoff_secs>
<backoff_secs>
Instructs the STB to send ICMP echo (ping) requests to a remote host.
PROC <proc_entry> <proc_entry> Sends specifiedprocproc entry to the STB.
PS Runs thepsps process on the STB.
REBOOT Reboots the STB.
REFLASH Wipes the NAND flash on the STB, then
downloads new software.
REFORMAT (Minerva and Evo only) Sets a flag on the STB to reformat the hard drive after a reboot. The STB will reboot to perform this command.
USING STBREMOTECONF