====== SiliconDust TECH manual ======
<lead>Documentation relating to the commercial-grade TECH product line from SiliconDust.</lead>

===== Hardware =====
<WRAP indent>

==== Ethernet ====
<WRAP indent>

Connect the Ethernet port(s) to a network switch. On models with multiple ports, all ports must be connected in order for all tuners to be accessible. A single port can be directly connected to the network interface on a PC to access that specific device. All ports are auto-crossover so a standard Ethernet cable can be used.

</WRAP>

</WRAP>
===== Additional Tools and Software =====
<WRAP indent>

====Firmware====
<WRAP indent>

Firmware downloads: https://www.silicondust.com/support/tech/

</WRAP>
====Windows====
<WRAP indent>

Download and install the latest Windows release of the HDHomeRun software: https://download.silicondust.com/hdhomerun/hdhomerun_tech_windows.exe

The HDHomeRun Setup wizard is optional.

When the installation process is complete it is recommended that the HDHomeRun program directory be added to the PATH so that the hdhomerun_config utility can be run from a cmd prompt. The default program directory is “C:\Program Files\Silicondust\HDHomeRun\”

</WRAP>
====Linux====
<WRAP indent>

Download and extract the libhdhomerun archive.

Run "make" to compile hdhomerun_config (systems that use a non-GNU make by default may need to install and use "gmake" instead).

Copy hdhomerun_config to /usr/local/bin

</WRAP>

</WRAP>
===== Command Line Utility (hdhomerun_config) =====
<WRAP indent>

Open a command prompt or terminal window and change directory to the HDHomeRun installation directory: "C:\Program Files\Silicondust\HDHomeRun\"

The list of supported commands can be obtained by running hdhomerun_config without any parameters:

<WRAP indent>
<code>
hdhomerun_config discover
hdhomerun_config <id> get help
hdhomerun_config <id> get <item>
hdhomerun_config <id> set <item> <value>
hdhomerun_config <id> scan <tuner> [<filename>]
hdhomerun_config <id> save <tuner> <filename>
hdhomerun_config <id> upgrade <filename>
</code>
</WRAP>

==== Discover devices on the network ====
<WRAP indent>

The discover command will find devices that are on the same subnet as the host:

<WRAP indent>
<code>
hdhomerun_config discover
</code>
</WRAP>

</WRAP>
==== Sending commands to a specific device ====
<WRAP indent>

The “<id>” shown above represents a unique identifier for a device, this can be either Device ID, or IP address:

<WRAP indent>
<code>
hdhomerun_config <device id> get help
hdhomerun_config <ip address> get help
</code>
</WRAP>

To address by Device ID the device must be on the same subnet as the host.

A Device ID of FFFFFFFF can be used as a wild card for the first device found on the network. Do not use this syntax if there are multiple devices on the network, as the device used will be random based on discovery order, which may change between commands.

</WRAP>
</WRAP>

===== Supported Commands =====
<WRAP indent>

The get/set options supported by a specific device can be queried using the get help command:

<WRAP indent>
<code>
hdhomerun_config <id> get help
</code>
</WRAP>

Example output:

<WRAP indent>
<code>
/card/status					Get status of CableCARD (6CC only)
/oob/channel <modulation>:<freq>		Get/set out of band channel (6CC only)
/oob/debug					Get out of band channel debug info (6CC only)
/oob/status					Get out of band channel status info (6CC only)
/sys/boot					<config> Get/set boot configuration
/sys/copyright					Get copyright information
/sys/debug					Get/set system debug information
/sys/features					Get system feature information
/sys/hwmodel					Get system hardware model string
/sys/ipaddr dhcp|"<ip> <mask> <gw> <dns>"	Get/set system IP address
/sys/model					Get/set model string
/sys/restart					<resource> Restart device/component
/sys/version					Get firmware version
/tuner<n>/channel <modulation>:<freq|ch>	Get/set channel
/tuner<n>/channelmap <channelmap>		Get/set channelmap
/tuner<n>/debug					Get tuner debug information
/tuner<n>/filter "0x<nnnn>-0x<nnnn> […]"	Get/set tuner PID filter
/tuner<n>/lockkey				Get/set tuner locking
/tuner<n>/plotsample				Get raw plotsample data from tuner
/tuner<n>/program <program number>		Get/set MPEG program
/tuner<n>/streaminfo				Get list of programs on current channel
/tuner<n>/status				Get tuner status
/tuner<n>/target <ip>:<port>			Get/set stream target
/tuner<n>/vchannel <vchannel>			Get/set virtual channel number (6CC only)
/tuner<n>/vstatus				Get/set subscription/protection status (6CC only)
</code>
</WRAP>

==== Channel scan ====
<WRAP indent>
To run a channel scan:

<WRAP indent>
<code>
Format: hdhomerun_config <id> scan /tuner<n> [log filename]
Example: hdhomerun_config FFFFFFFF scan /tuner0 scan0.log
</code>
</WRAP>

This command will scan all channels on the selected channel map plus any additional channel maps associated with the selected channel map. All standard modulation types for the selected channel map are tested.

When a digital channel is found it will identify the programs on the channel.

The log filename is optional; if included it will log to the given filename.

</WRAP>
==== Tuning a physical channel ====
<WRAP indent>

To set a channel use the set channel command:

<WRAP indent>
<code>
Format: hdhomerun_config <id> set /tuner<n>/channel <modulation>:<frequency>
Format: hdhomerun_config <id> set /tuner<n>/channel <modulation>:<channel>
Example: hdhomerun_config FFFFFFFF set /tuner0/channel auto:651000000
Example: hdhomerun_config FFFFFFFF set /tuner0/channel auto:60
</code>
</WRAP>

To auto-detect the modulation type use “auto” for the modulation.

Supported modulation types can be queried with the get sys-features command:

<WRAP indent>
<code>
hdhomerun_config <id> get /sys/features
</code>
</WRAP>

To stop the tuner set the channel to none:

<WRAP indent>
<code>
Format: hdhomerun_config <id> set /tuner<n>/channel none
Example: hdhomerun_config FFFFFFFF set /tuner0/channel none
</code>
</WRAP>

</WRAP>
==== Tuning a virtual channel (TECH3-CC only) ====
<WRAP indent>

To set a virtual channel use the set vchannel command:

<WRAP indent>
<code>
Format: hdhomerun_config <id> set /tuner<n>/vchannel <virtual channel>
Example: hdhomerun_config FFFFFFFF set /tuner0/vchannel 702
</code>
</WRAP>

To stop the tuner set the vchannel to none:

<WRAP indent>
<code>
Format: hdhomerun_config <id> set /tuner<n>/vchannel none
Example: hdhomerun_config FFFFFFFF set /tuner0/vchannel none
</code>
</WRAP>

</WRAP>
==== Checking the signal strength ====
<WRAP indent>

The basic signal information can be obtained by using the get status command:

<WRAP indent>
<code>
Format: hdhomerun_config <id> get /tuner<n>/status
Example: hdhomerun_config FFFFFFFF get /tuner0/status
</code>
</WRAP>

Example output:

<WRAP indent>
<code>
ch=qam:33 lock=qam256 ss=83(-10dBmV) snq=90(29dB) seq=100 bps=38807712 pps=0
</code>
</WRAP>

  * ch = channel requested
  * lock = actual modulation detected
  * ss = signal strength.
  * snq = signal to noise quality (MER).
  * seq = symbol error quality (based on the number of uncorrectable digital errors detected).
  * bps = raw channel bits per second.
  * pps = packets per second sent through the network.

More advanced information can be obtained by using the get debug command:

<WRAP indent>
<code>
Format: hdhomerun_config <device id> get /tuner<n>/debug
Example: hdhomerun_config FFFFFFFF get /tuner0/debug
</code>
</WRAP>

Example output:

<WRAP indent>
<code>
tun: ch=qam:33 lock=qam256 ss=84 snq=88 seq=100 dbg=22081-6930
dev: resync=0 overflow=0
ts: bps=38809216 ut=94 te=0 miss=0 crc=0
flt: bps=38809216
net: pps=0 err=0 stop=0
</code>
</WRAP>

Each line contains a prefix to indicate the type of data, followed by the values.

  * tun = tuner status
    * see above section
  * dev = device status
  * ts = transport stream
    * bps = bits per second
    * ut = utilization percentage (100% is filled to capacity)
    * te = transport error counter (uncorrectable reception error)
    * miss = missed packet counter (jump in sequence numbers)
    * crc = crc error counter
  * flt = results after pid filtering
    * bps = bits per second
  * net = network status
    * pps = packets per second
    * err = packets or TS frames dropped before transmission.
    * stop = reason for stopping the stream

The counters are reset to zero upon a channel change, but may indicate a small number of errors caused before the tuner locks on the channel. As a result, diagnostics should be based on the change in values over time, and not the initial values.Detecting the programs on a physical channel:

The device will detect the programs (sub-channels). Use the get streaminfo command to query the detected programs:

<WRAP indent>
<code>
Format: hdhomerun_config <id> get /tuner<n>/streaminfo
Example: hdhomerun_config FFFFFFFF get /tuner0/channel streaminfo
</code>
</WRAP>

The output format is:

<WRAP indent>
<code>
<program number>: <virtual major>.<virtual minor> [<name>] [(<flags>)]
</code>
</WRAP>

Example output:

<WRAP indent>
<code>
3: 20.1 KBWB-HD
4: 20.4 AZTECA
</code>
</WRAP>

Digital cable does not always provide the channel name or virtual channel number:

<WRAP indent>
<code>
1: 0.0
2: 0.0 (encrypted)
3: 0.0 (control)
</code>
</WRAP>

It may take several seconds after setting the channel for the stream information to be fully populated (depending on how long the channel takes to lock and how often the stream information is sent by the broadcaster/cable provider).

</WRAP>
==== Filtering by program (sub-channel) ====
<WRAP indent>

TECH3 and later supports automatic PID filtering by program number or virtual channel number:

<WRAP indent>
<code>
Format: 	hdhomerun_config <id> set /tuner<n>/program <program number>
		hdhomerun_config <id> set /tuner<n>/program <virtual channel number>
Example: 	hdhomerun_config FFFFFFFF set /tuner0/program 3
		hdhomerun_config FFFFFFFF set /tuner0/program 11.2
</code>
</WRAP>

When filtering by program the MPEG TS tables are generated by the device. The result is a valid single-program transport stream.

The program filter is cleared when a set channel or a set filter command is received.

**Advanced:** By default the PAT and PMT are generated. To also generate a ATSC-style TVCT use:

<WRAP indent>
<code>
hdhomerun_config <id> set /tuner<n>/program "<program number> tvct_from_pmt=<virtual major>.<virtual
minor>(<name>)"
</code>
<code>
Example: hdhomerun_config <id> set /tuner0/program "3 tvct_from_pmt=11.2(TEST)"
</code>
</WRAP>

</WRAP>
==== Filtering by PID ====
<WRAP indent>

The TECH supports arbitrary hardware PID filtering:

<WRAP indent>
<code>
Format: 	hdhomerun_config <id> set /tuner<n>/filter <filter>
Example: 	hdhomerun_config FFFFFFFF set /tuner0/filter "0x0000-0x1FFF"
		hdhomerun_config FFFFFFFF set /tuner0/filter "0x0000 0x0030-0x0033 0x1FFB"
</code>
</WRAP>

When filtering by PID the stream is filtered but otherwise unmodified.

The filter is cleared to pass-all (0x0000-0x1FFF) when a set channel command is received.

</WRAP>
==== Saving a stream ====
<WRAP indent>

The hdhomerun_config command can be used to automate the process of saving to the local filesystem:

<WRAP indent>
<code>
Format: hdhomerun_config <id> save /tuner<n> <filename>
Example: hdhomerun_config FFFFFFFF save /tuner0 capture.ts
</code>
</WRAP>

While saving the stream, a single period “.” will be displayed every second. Errors will be indicated by
a letter.

Example output:
<WRAP indent>
<code>
............n...............................n..........ts..........
-- Video statistics --
23323 packets recieved, 2 network errors, 1 transport errors, 1 sequence errors
</code>
</WRAP>

**Advanced:** A filename of “null” indicates no file should be created, allowing the use of the save command as a diagnostic tool.

**Advanced:** “-” may be used as a filename to indicate standard output, allowing the save command to be used as a pipe on supported platforms.

<WRAP indent>
<code>
Example: hdhomerun_config FFFFFFFF save /tuner0 - | vlc -
</code>
</WRAP>

</WRAP>
==== Streaming to a target machine ====
<WRAP indent>

Set the target IP address and port number using the set target command:

<WRAP indent>
<code>
Format: hdhomerun_config <id> set /tuner<n>/target udp://<ip>:<port>
Format: hdhomerun_config <id> set /tuner<n>/target rtp://<ip>:<port>
Example: hdhomerun_config FFFFFFFF set /tuner0/target udp://192.168.1.100:5000
Example: hdhomerun_config FFFFFFFF set /tuner0/target rtp://192.168.1.100:5000
</code>
</WRAP>

The target machine must be listening on the given UDP port. The TECH3 will automatically clear the target if a ICMP port unreachable message is received when sending to a unicast address. To override this, add no_clear to the target.

<WRAP indent>
<code>
Format: hdhomerun_config <id> set /tuner<n>/target "udp://<ip>:<port> no_clear"
Format: hdhomerun_config <id> set /tuner<n>/target "rtp://<ip>:<port> no_clear"
Example: hdhomerun_config FFFFFFFF set /tuner0/target "udp://192.168.1.100:5000 no_clear"
Example: hdhomerun_config FFFFFFFF set /tuner0/target "rtp://192.168.1.100:5000 no_clear"
</code>
</WRAP>

A global broadcast (255.255.255.255), subnet broadcast, or multicast target can be specified however care must be taken to ensure that the traffic will not cause problems with other devices on the network.

If the local network is bridged to a wireless network then the AP will typically transmit at a low broadcast speed saturating the wireless network.

The time-to-live (TTL) defaults to 64. To configure a lower TTL use the following format (quotes required):

<WRAP indent>
<code>
Format: hdhomerun_config <id> set /tuner<n>/target "udp://<ip>:<port> ttl=<n>"
Format: hdhomerun_config <id> set /tuner<n>/target "rtp://<ip>:<port> ttl=<n>"
Example: hdhomerun_config FFFFFFFF set /tuner0/target "udp://192.168.1.100:5000 ttl=8"
Example: hdhomerun_config FFFFFFFF set /tuner0/target "rtp://192.168.1.100:5000 ttl=8"
</code>
</WRAP>

</WRAP>
==== Example: Streaming to VLC ====
<WRAP indent>

Run VLC: Media, Open Network Stream. Select UDP/RTP. Specify port 5000.

Discover the device:

<WRAP indent>
<code>
hdhomerun_config discover
</code>
</WRAP>

Run a channel scan:

<WRAP indent>
<code>
hdhomerun_config FFFFFFFF scan /tuner0 scan0.log
</code>
</WRAP>

Set the physical channel:

<WRAP indent>
<code>
hdhomerun_config FFFFFFFF set /tuner0/channel auto:651000000
</code>
</WRAP>

Check sub-programs:

<WRAP indent>
<code>
hdhomerun_config FFFFFFFF get /tuner0/streaminfo
</code>
</WRAP>

Select a sub-program:

<WRAP indent>
<code>
hdhomerun_config FFFFFFFF set /tuner0/program 3
</code>
</WRAP>

Set the target:

<WRAP indent>
<code>
hdhomerun_config FFFFFFFF set /tuner0/target udp://<ip address of pc>:5000
</code>
</WRAP>

</WRAP>
</WRAP>

===== HTTP Streaming (TECH3-CC only) =====
<WRAP indent>
TECH3-CC models can be used to stream via HTTP (unicast only) to VLC or other clients.

<WRAP indent>
<code>
Format: http://<ip address of device>:5004/auto/v<vchannel number>
Example: http://10.10.10.2:5004/auto/v721
</code>
</WRAP>

</WRAP>

===== Lineup file (TECH3-CC only) =====
<WRAP indent>
TECH3-CC units support virtual channel lineup information transmitted by the cable provider and received via the CableCARD. This is available in XML and JSON format.

<WRAP indent>
<code>
http://<ip address of device>/lineup.xml
http://<ip address of device>/lineup.json
</code>
</WRAP>

</WRAP>

===== Datacast operation =====
<WRAP indent>

TECH3 units support Datacast TCP/IP over OTA broadcast. Datacasting often provides news, weather, traffic, stock market, and other information which may or may not relate to the program[s] it is carried with. An electronic program guide is usually included. Datacast TCP-IP packets are reassembled and then routed to the LAN port.

Example:

Discover the device:

<WRAP indent>
<code>
hdhomerun_config discover
</code>
</WRAP>

Set the physical channel:

<WRAP indent>
<code>
hdhomerun_config FFFFFFFF set /tuner0/channel auto:651000000
</code>
</WRAP>

Set the datacast PID:

<WRAP indent>
<code>
hdhomerun_config FFFFFFFF set /tuner0/filter 0x0A00
</code>
</WRAP>

Set the target:

<WRAP indent>
<code>
hdhomerun_config FFFFFFFF set /tuner0/target datacast
</code>
</WRAP>

</WRAP>

===== Using /sys/boot =====
<WRAP indent>

The /sys/boot variable allows the TECH unit to automatically set variables at startup, allowing you to preserve settings across power outages or simply set the power on defaults.

The syntax for the /sys/boot consists of multiple lines of text; a variable name followed by a single space and then the value: (there should not be any space before the variable name)

<WRAP indent>
<code>
<variable1> <value of variable1>
<variable2> <value of variable2>
...
<variableN> <value of variableN>
</code>
</WRAP>

Example (save as boot.txt):

<WRAP indent>
<code>
/tuner0/channelmap us-cable
/tuner0/channel 103
/tuner0/program 4
</code>
</WRAP>

To store the configuration to the device:

<WRAP indent>
<code>
Format: hdhomerun_config <id> set /sys/boot - < filename
Example: hdhomerun_config FFFFFFFF set /sys/boot - < boot.txt
</code>
</WRAP>

Changes will be applied the next boot; to execute the new /sys/boot immediately:

<WRAP indent>
<code>
Format: hdhomerun_config <id> execute
Example: hdhomerun_config FFFFFFFF execute
</code>
</WRAP>

==== Static IP assignment ====
<WRAP indent>

A static IP address can be configured using the following command (the quotes are required as shown):

<WRAP indent>
<code>
Format: hdhomerun_config <old ip> set /sys/ipaddr "<new ip> <subnet> <gateway>"
Example: hdhomerun_config 169.254.34.98 set /sys/ipaddr "10.10.20.43 255.255.255.0 10.10.20.1"
</code>
</WRAP>

Note: The TECH requires a gateway when used to stream multicast, even if on the same subnet.

</WRAP>
==== Reverting to DHCP ====
<WRAP indent>

The TECH can be configured for DHCP operation (default) using the following command:

<WRAP indent>
<code>
Format: hdhomerun_config <old ip> set /sys/ipaddr dhcp
Example: hdhomerun_config 169.254.34.98 set /sys/ipaddr dhcp
</code>
</WRAP>

</WRAP>

</WRAP>

===== Setting the channel map =====
<WRAP indent>

The channel map is a non-volatile configuration option that is used to set the channel to frequency table, to configure the channel scan table, and to optimize the auto-modulation detection.

GUI: The channel map can be set for each tuner by running HDHomeRun Config (GUI).

Command line: The channel map can be set for each tuner using the following command:

<WRAP indent>
<code>
Format: hdhomerun_config <ip|id> set /tuner<n>/channelmap <channelmap>
Example: hdhomerun_config 10001000 set /tuner0/channelmap us-cable
Example: hdhomerun_config 10001000 set /tuner1/channelmap us-cable
</code>
</WRAP>

Channel maps supported by HDHR-TECH-US hardware:

<WRAP indent>
^ Name ^ Description ^ Location ^
| us-bcast | Digital Antenna (ATSC). | US, Canada |
| us-cable | Digital Cable - Normal frequency layout. | US, Canada |
| us-hrc | Digital Cable - HRC frequency layout. | US, Canada |
| us-irc | Digital Cable - IRC frequency layout. | US, Canada |
</WRAP>

Channel maps supported by HDHR-TECH-EU hardware:

<WRAP indent>
^ Name ^ Description ^ Location ^
| au-bcast | Digital Antenna (Australia). | Australia |
| au-cable | Digital Cable (Australia). | Australia |
| eu-bcast | Digital Antenna (Europe). | Europe, New Zealand |
| eu-cable | Digital Cable (Europe). | Europe, New Zealand |
| tw-bcast | Digital Antenna (Taiwan). | Taiwan |
| tw-cable | Digital Cable (Taiwan). | Taiwan |
</WRAP>