This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Installation Guides

The installation guides instruct you step by step how to install the following products:

1 - File Gateway Installation Guide

An Amazon S3 File Gateway enables you to share files between your on-premises components and the company's components within your solution deployed in AWS. For example, asset metadata is collected and managed in your on-premises data management system. The asset metadata must be sent to the company's asset processing component for further processing and use by other company components. In this example, the S3 File Gateway provides you with a local network drive location to drop the asset metadata and eliminates a complex integration between your on-premises components and the cloud components in your solution.

The solution consists of:

  • an S3 File Gateway: software provided by AWS, which you must install and configure in a virtual machine within your network
  • an AWS gateway configuration: a configuration within AWS maintained by the company
  • an AWS file share configuration: an SMB/NFS configuration within AWS maintained by the company
  • one or more AWS S3 buckets: storage in AWS, configured and maintained by the company

1.1 - Prerequisites

Before you install the S3 File Gateway, make sure that the following prerequisites are met:

For more information on prerequisites, see File Gateway setup requirements - AWS Storage Gateway.

1.2 - Installation process

As a customer, you do not have access to the AWS console where the company deploys the components needed for your solution. As a result, certain steps in setting up the S3 File Gateway are executed by a company representative. The following diagram illustrates the stages in the process and who executes them:

flowchart
    subgraph Customer
        direction TB
        st0((START)) --> st1
        st1(Request link to S3 File Gateway virtual machine image)
        st3(Install and configure S3 File Gateway virtual machine image) --> st4(Test S3 File Gateway connectivity)
        st4 --> st5{Success?}
        st5 -- no --> st6a(Configure firewall and router to access service endpoints)
        st6a --> st4
        st5 -- yes --> st6b{Provide the company with access to VM?}
        st6b -- no --> st7b(Set up second machine with AWS CLI and cURL)
        st7b --> st8(Request AWS credentials)
        st11(Set up credentials on secondary machine) --> st12(Run commands on secondary machine to configure and activate S3 File Gateway)
        st12 --> st13(Notify the company of successful setup)
    end
    subgraph The company
        direction TB
        st2(Provide URL to customer)
        st7a(Configure and activate S3 File Gateway) --> st15((END))
        st9(Set up temporary AWS user) --> st10(Send credentials and information to customer)
        st14(Remove temporary AWS user) --> st15
    end
    st1 --> st2
    st2 --> st3
    st6b -- yes --> st7a
    st8 --> st9
    st10 --> st11
    st13 --> st14

1.2.1 - Install S3 File Gateway virtual machine

In this stage, you request where to download the S3 File Gateway and install in your hypervisor.

  1. Contact your designated company representative, and request the URL to the file gateway and the AWS region. Provide the hypervisor you have with your request to receive the correct URL. Only the following hypervisors are supported:
    • VMware ESXi Hypervisor
    • Microsoft Hyper-V Hypervisor
    • Linux Kernel-based Virtual Machine
  2. Download the S3 File Gateway virtual machine (VM) image and install it in your hypervisor. Ensure the following minimum setup:
    • Processors: 4
    • RAM: 16 GB
    • Disk for VM image and system data: 80 GB
    • Additional cache disk: 150 GB
    • Network adapter: NAT

1.2.2 - Test network connection

In this stage, you must test the network connection to your S3 File Gateway.

  1. Log into your virtual machine. A screen similar to the following is displayed:

  2. Enter the command to “Test Network Connectivity” and press Enter.

  3. Select the “Public” endpoint type and press Enter.

  4. Enter the AWS region, which you have received from your designated company representative, and press Enter.

    1. If the test is successful, continue with the procedure.

    2. If the test is unsuccessful, then configure your firewall and router to allow traffic from the AWS service endpoints described here: Allowing AWS Storage Gateway access through firewalls and routers.

      Perform the test again to verify access after the firewall and router configuration.

1.2.3 - Configure and activate gateway

In this stage, the S3 File Gateway is configured and activated. How this happens depends on whether or not the company is granted access to the virtual machine where you installed the S3 File Gateway.

The company can have access to VM

If you allow the company, even temporary, access to the virtual machine where you installed the S3 File Gateway, then the company can configure and activate the S3 File Gateway.

Inform your designated company representative that you have successfully installed and tested the S3 File Gateway virtual machine. Provide the following information:

  • How to connect to the virtual machine (IP address).
  • How to access your network, in case the virtual machine is within a restricted network.
  • The credentials to log into the virtual machine.

If the S3 File Gateway virtual machine is in a restricted network, then provide and request the information needed to allow the company access to the restricted network. For example, you may have to open your network to specific IP addresses from the company, which the company needs to provide to you.

The company cannot have access to VM

If you cannot provide access to the virtual machine to the company, then you must execute the following steps to configure and activate the S3 File Gateway in AWS:

  1. Request AWS credentials and S3 File Gateway information from your designated company representative. You receive the following information:

    • aws_access_key_id: the access key ID of the AWS user
    • aws_secret_access_key: the access key of the AWS user
    • region: the region where the File Gateway will be activated (the region is the same as the region you tested against in the previous stage)
    • gateway-name: the name of the File Gateway in AWS
    • activation-key: the activation key of the File Gateway in AWS

  2. Create a new virtual machine within the same network as the File Gateway virtual machine with the following tools installed:

  3. Log into your new virtual machine

  4. Set up the AWS CLI credentials file with the following information:

    [gwinstall]
aws_access_key_id = <aws_access_key_id provided by the company>
aws_secret_access_key = <aws_secret_access_key provided by the company>

  5. Set up the AWS CLI configuration file with the following information:

    [profile gwinstall]
region = <region provided by the company>

  6. Run the following AWS CLI command to activate the gateway:

    aws activate-gateway \
--activation-key <activation-key provided by the company>\
--gateway-name <gateway-name provided by the company>\
--gateway-timezone <timezone of the File Gateway VM>\
--gateway-region <region provided by the company>\
--profile gwinstall

    This command outputs the AWS File Gateway ARN, which is needed in the following command:

    {
    "GatewayARN": "arn:aws:storagegateway:<region>:<account#>:gateway/sgw-<gateway-id>"
}

  7. Run the following AWS CLI command to list the disks in your File Gateway VM:

    aws --profile gwinstall storagegateway list-local-disks --gateway-arn <GatewayARN>

    The command outputs the list of disks in your File Gateway VM:

    {
    "GatewayARN": "<GatewayARN>",
    "Disks": [
        {
            "DiskId": "92e81768-7ac1-4523-9c59-1043a27121cb",
            "DiskPath": "/dev/sdb",
            "DiskNode": "SCSI (0:1)",
            "DiskStatus": "present",
            "DiskSizeInBytes": 161061273600,
            "DiskAllocationType": "AVAILABLE",
            "DiskAttributeList": []
        }
    ]
}

  8. Run the following AWS CLI command, using the DiskId from the output from the previous command, to identify the cache disk of the File Gateway to the setup in AWS:

    aws --profile gwinstall storagegateway
              add-cache --gateway-arn <GatewayARN> --disk-ids
        "<DiskId>"

  9. Notify your designated company representative that you have finalized AWS File Gateway configuration and activation, and request to verify the File Gateway in AWS. When you receive confirmation, you can continue with the next steps to request the AWS File shares necessary for your solution.

1.3 - Next steps

In the next steps, the company sets up one or more AWS File shares as needed for your solution and according to your network file sharing protocol:

  • SMB, which is standard for Microsoft Windows environments
  • NFS, which is standard for Linux environments

When the AWS File shares are available, the company provides you with the necessary commands to map the AWS File share to your local network folder and asks you to send a test file to test the setup.

2 - Live TV App Installation Guide

The Live TV app is an Android TV app to be installed on Android TV boxes that sit in the distributor's headend. The Live TV app enables ad insertion into a specific network stream for a specific region.

You need one Android TV box, with the Live TV app installed, for each network stream you broadcast and each region where targeted ads are inserted. For example, if you have three networks that are served in five regions, then you need ( 3 x 5 ) = 15 Android TV boxes.

The regions are defined by you in collaboration with your ratings data provider. The regions must be closely related to how your physical video distribution is set up. The defined regions are used to target your ad campaigns.

To summarize, you need to:

  • install the Live TV app on Android TV boxes, for each combination of region and network,
  • place a configuration file on each Android TV box, identifying the device and the combination of network and region it serves,
  • and tune the Live TV app on each Android TV box to the correct network.

Features

The Live TV app has the following features:

  • Insertion of addressable ads based on SCTE-35 cue data in the network stream. Ads inserted are based on the combination of region and network configured in the Live TV app on the Android TV box.

  • Overlay the channel logo, including special time limited logos, during addressable ad playback.

Limitations

Only the following Android TV boxes are supported by the Live TV app:

  • SEI Robotics 804

Other limitations:

  • When the network stream is disconnected and later reconnected to the Android TV box, either due to physically disconnecting the cable or due to network stream errors, then an operator must re-tune the Android TV box to the correct network stream. See Troubleshooting for more information.
  • Installing new versions of the Live TV app must be done by an operator on site, because the company has no access to the network where the Android TV boxes are located to deliver over-the-air (OTA) updates.

2.1 - Prerequisites

Before you install the Live TV app, make sure that the following prerequisites are met:

  • You have the latest version of the Live TV app on your computer. If not, contact your designated company representative and request the latest version.
  • You have the Android Debug Bridge (adb) command-line tool installed on your computer. For more information on how to install the adb command-line tool, see https://developer.android.com/tools/releases/platform-tools.
  • Your computer and the Android TV box are located on the same network.
  • The network stream is connected to the input port of the Android TV box.

2.2 - Security recommendations

The company recommends the following security measures for the Android TV boxes installed in your environment:

  • Updates to the operating system should be installed on the Android TV boxes when they become available from the manufacturer.
  • Updates to the Live TV app should be installed on the Android TV boxes when they become available from the company.
  • The Android TV boxes should be installed in an isolated network, because the devices themselves do not support authentication, and do not have a firewall embedded.
  • The Android TV boxes should only connect to the isolated network through an Ethernet cable and the wireless connection capabilities should be disabled.
  • Incoming access to the Android TV boxes should be provided through a jump host, a gateway, or similar technologies.
  • Outgoing access from the Android TV boxes to the company's cloud services must be allowed.

2.3 - Installation process

Enable USB debugging and fetch IP address

Although you connect to the Android TV box over your network, you must enable USB debugging on the Android TV box before you can install the Live TV app through the Android Debug Bridge (adb). Follow these instructions:

  1. Using the remote control, go into the Settings on the Android TV box.
  2. In Settings, select Device Preferences.
  3. In Device Preferences, select About.
  4. In About, select Android TV OS build seven times until you see the message You are now a developer! pop up on the screen.
  5. Press the back button on the remote to go back to the Device Preferences menu.
  6. In Device Preferences, select Developer options.
  7. In Developer options, select USB debugging, and then select OK.
  8. Press the back button on the remote to go back to the Device Preferences menu.
  9. In Device Preferences, select About.
  10. In About, select Status.
  11. In Status, note down the entry under IP address, for example, 10.200.0.111. The IP address is used in a later stage to connect through adb to the Android TV box over your network.
  12. Press the back button on the remote until you exit Settings.

You can now connect to the Android TV box over your network, load the configuration file and install the app.

Upgrade the vendor DTVKit implementation

DTVKit provides an interface that allows live TV applications, such as Live TV app, to scan and show digital TV broadcasts on an Android TV box.

Follow these instructions to upgrade the vendor DTVKit implementation:

  1. Download the dtvkitserver package.

  2. Enter the following command from the terminal to connect to the Android TV box:

    adb connect <IP address of your Android TV box>

    For example:

    > adb connect 10.200.0.111
connected to 10.200.0.111:5555

  3. Enter the following command to assume root permissions on the Android TV box:

    adb root

  4. Enter the following command to make the /system partition on the Android TV box writable:

    adb remount

  5. Enter the following command to upgrade the vendor DTVKit:

    adb push <local path to dtvkitserver file> /vendor/bin/hw

  6. Enter the following command to reboot the Android TV box:

    adb reboot

  7. After the Android TV box has rebooted, reconnect to the device:

    adb connect <IP address of your Android TV box>

  8. Enter the following command to open an interactive shell on the Android TV box:

    adb shell

  9. Enter the following command to browse to the vendor DTVKit location:

    cd /vendor/bin/hw

  10. Enter the following command to verify the version of the new vendor DTVKit:

    file dtvkitserver

    The output of this command should be as follows:

    build:dtvkitserver: ELF shared object, 32-bit LSB arm, 
dynamic (/system/bin/linker), for Android 31, 
BuildID=8a9e61ee3ce6eda78350b7a0dc44b5f6

  11. Enter the following command to exit the interactive shell:

    exit

  12. Enter the following command to disconnect from the Android TV box:

    adb disconnect <IP address of your Android TV box>

    For example:

    > adb disconnect 10.200.0.111
disconnected 10.200.0.111:5555

Create and load configuration file

The Live TV app requires a configuration file to be present on the Android TV box to make ad requests for the correct network and region the Android TV box is assigned to. Follow these instructions before installing the Live TV app:

  1. Create a plain text file on your computer containing the following information:

    • pid: the Personal IDentifier, which is used to identify the Android TV box to the ad insertion service. The pid must be unique across all the Android TV boxes where you install the Live TV app. We recommend to use a numerical value, for example 0001.
    • channel: the channel that this Android TV is tuned to. The name must match the exact name of the network stream as it is used in the targeting on the ad campaigns.
    • region: the region that this Android TV serves. The name must match the exact name of the region as it is used in the targeting on the ad campaigns.
    • account: the subdomain of your product account.
    • logo_position: the position where the channel logo is shown during ad playback. Possible values are: top-left, top-right, bottom-left, or bottom-right. The default value is top-right.

    For example:

    pid=0001
channel=channel1
region=region1
account=in-rel-demo
logo_position=bottom-left

  2. Save the file with the name company.properties.

  3. Enter the following command from the terminal to connect to the Android TV box:

    adb connect <IP address of your Android TV box>

    For example:

    > adb connect 10.200.0.111
connected to 10.200.0.111:5555

  4. Enter the following command to push the configuration file to the Android TV box in the /sdcard/Download/ location:

    adb push <local path to company.properties file> /sdcard/Download/

    For example:

    > adb push /Users/XXX/Desktop/box2/company.properties /sdcard/Download/
/Users/XXX/Desktop/box2/company.properties: 1 file pushed, 0 skipped. 0.0 MB/s (65 bytes in 1.127s)

  5. Enter the following command to disconnect from the Android TV box:

    adb disconnect <IP address of your Android TV box>

    For example:

    > adb disconnect 10.200.0.111
disconnected 10.200.0.111:5555

Install app

In this stage, you install the Live TV app. Follow these instructions:

  1. Enter the following command from the terminal to connect to the Android TV box:

    adb connect <IP address of your Android TV box>

    For example:

    > adb connect 10.200.0.111
connected to 10.200.0.111:5555

  2. Enter the following command to install the Live TV app, and wait until you see the success message:

    adb install -r -g <local path to the Live TV app>

    For example:

    > adb install -r -g ~/Desktop/live_0.1.4.apk
Success

    In this command the flags have the following meaning:

    • -r: this flag is used to reinstall an existing app while keeping the data from the previous installation.
    • -g: this flag is used to automatically set all permissions that are needed by the app.

  3. Wait for 30 seconds after receiving the Success message on the command line before you continue with the procedure.

  4. Enter the following command to disconnect from the Android TV box:

    adb disconnect <IP address of your Android TV box>

    For example:

    > adb disconnect 10.200.0.111
disconnected 10.200.0.111:5555

  5. Using the remote, browse to the Live TV app, and long press the select button. The context menu appears:

  6. From the context menu, select Info. The Live TV menu appears:

  7. In the Live TV menu, check that the version number of the installed app matches the version you installed on the Android TV box through the adb command.

    You may be handling many Android TV boxes, so this verification step is important to ensure you are executing the rest of the procedure on the same device.

  8. On the remote, press the back button until you are back in the home screen.

Configure app

In this stage, you configure the Live TV app to tune to the correct network. Follow these instructions:

  1. Using the remote, browse to the Live TV app and launch it. The Live TV app screen appears:

  2. Keep clicking on next (>) until the GET STARTED screen appears:

  3. Select GET STARTED. The Set up your sources screen appears:

  4. Select DTVKit2. The channel setup screen appears:

  5. Set up the following fields:

    • Country (Region): select the country or region.
    • Search Mode: select Manual.
    • Channel No.: select the channel to which the app needs to be tuned.
      • Frequency (KHz): the frequency changes according to the selected channel. Do not manually change this setting.
      • SymbolRate: set the symbol rate to align with the symbol rate of your QAM modulator in kilo symbols/second. For example, if the symbol rate is 6,900,000 symbols/second, then SymbolRate needs to be set to 6,900.
    • Mode: select the correct modulator constellation according to the modulator used for the input stream. For example, 64QAM.
    • NIT: select off.
    • Scan Type: select All.
    • Service Type: select All.

  6. Select Scan. The screen changes for a brief time to a scanning screen and then returns to the channel setup screen.

  7. Verify that S (Strength) and Q (Quality) are both 90% or more on the channel setup screen. If the values are not 90% or more, then adjust SymbolRate to the correct value and select Scan until S and Q are both 90% or more.

  8. Using the remote, click the back button to return to the Set up your sources screen.

  9. Select Done.

  10. Press the back button until you are back on the home screen of the Android TV box.

  11. Relaunch the Live TV app to verify that the app is correctly set up and you can see the network you have configured.

Disable Developer options

For security reasons, Developer options must be disabled after you have successfully installed and configured the Live TV app. Follow these instructions:

  1. Using the remote control, go into the Settings on the Android TV box.
  2. In Settings, select Device Preferences.
  3. In Device Preferences, select Developer options.
  4. In Developer options, next to Enable developer options, select the toggle to disable Developer options.
  5. Press the back button until you are back on the home screen of the Android TV box.
  6. Relaunch the Live TV app.

2.4 - Troubleshooting

When something happens to one of your Android TV boxes, it may be necessary to troubleshoot the device. This topic helps you troubleshoot the most common issues.

Disconnected cables

USB to RF/DVB-C cable disconnected

When the USB to RF/DVB-C cable is disconnected from the Android TV box (see connection 1 in the image), then the app loses the tuned channel, and an operator must re-tune the app to the correct channel.

Follow this procedure to solve the issue:

  1. Reconnect the USB to RF/DVB-C cable to the Android TV box.
  2. Using the remote, from the home screen, browse to Settings > Device Preferences > Restart.
  3. Select Restart, and wait for the Android TV box to restart.
  4. After the Android TV box has restarted, browse to the Live TV app and launch it.
  5. Browse to TV Options > Settings > Channel sources. The Setup your sources screen appears.
  6. Continue the channel setup as described in Configure app from step 4.

Modulator disconnected from USB to RF/DVB-C cable

When the modulator is disconnected from the USB to RF/DVB-C cable (see connection 2 in the image), but the USB to RF/DVB-C cable is still connected to the Android TV box, then an operator only needs to reconnect the modulator to the USB to RF/DVB-C cable. The app automatically reconnects to the configured network stream.

Power cable disconnected

When the power cable is disconnected from the Android TV box (see connection 3 in the image), then an operator only needs to reconnect the power cable and relaunch the Live TV app. The app automatically reconnects to the configured network stream.

Replacing an Android TV box

When one of your Android TV boxes stops working, you must replace it with a new one, and you must upload the same configuration file that was present on the Android TV box you are replacing.

Follow the same installation process as described in Installation process, but use the existing configuration file when you execute the steps under Create and load configuration file.