Pair an Elemental
Requirements
- Computer with access to the Elemental
- One browser/tab open to the Sardius Control Panel
- A Command Line Interface (CLI) program to SSH into the Elemental.
For instructions on how to SSH into your Elemental, please review this article: Access your Elemental with SSH.
Walkthrough
Log into the Sardius Control Panel and locate "Devices" on the Sidebar.
Click "Add Device" in the upper right corner.
A modal will appear in the middle of the screen. Select "Elemental Encoder" from the options and click Next.
Enter a name for the Device in the "Encoder Name" field.
User Authentication
In order to pair your Elemental with the Sardius Control Panel, we must require you to set up user authentication on your Elemental. You will also need to provide a Username and an API Key in order for the Sardius Control Panel to remotely control your Elemental.
To learn more about enabling user authentication for your Elemental, please review this article: Enabling User Authentication for Your Elemental.
IMPORTANT: We recommend creating a User Account on your Elemental specifically for Sardius to use here. This is to keep your primary administrator account completely secure while still allowing our system to operate.
To learn more about setting up an account on your Elemental, please review this article: Creating User Accounts on your Elemental.
Enter the Username and API Key for the account you are allowing Sardius to use. Then click "Start Pairing" to continue.
Install Commands
You will be greeted by the first page of the Install Commands stepper. This guided stepper will walk you through the necessary steps to successfully pair your Elemental encoder with the Sardius Control Panel.
Please follow each step carefully to ensure a seamless integration and installation.
Click Next to begin the process.
Note: You can exit the pairing process at any time. If you do, you will have 24 hours to resume and complete the pairing process. If you do not complete the process within 24 hours, you will have to delete the pairing and start over.
Pairing - Step 1
As part of the pairing process, you will need to SSH into your Elemental encoder. If you are not familiar with how to SSH into your encoder, please review this article: Access your Elemental with SSH.
Once SSH access has been established, keep your CLI program open and proceed to Step 2.
Step 2
The stepper will give you a command that you will need to copy and paste into your SSH program. Click "Copy Command" to copy the code into your clipboard.
Switch over to your SSH program and paste the code you just copied. Press Enter.
The Elemental will test the connection and download the files for the SSM Agent, which will be the software Sardius will use to remotely access and control your Elemental. Once everything is staged for the installation, you may be prompted with a CAUTION notice as seen in the screenshot above. This is the expected response. After you have reviewed the caution, type "Yes" and press Enter.
The Elemental will then install the SSM Agent. You will see the progress happen in the CLI window. When it is complete, you will see "Complete!" at the bottom of the screen, followed by a new command entry line.
You will not need to enter anything new at this time. Return to the Sardius Control Panel and proceed with Step 3.
Step 3
Back in the Sardius Control Panel, advance to Step 3. In this step, you will have to register the SSM Agent with AWS. This will complete the registration process and fully pair your Elemental with the Sardius Control Panel.
Click "Copy Code" to copy the new command to your clipboard.
Note: The registration code and ID are unique to each pairing attempt and Elemental device. This is why the image above has these items redacted, and also why the codes are not available to be copied from this page.
Return to your SSH program, paste the code, and press Enter.
The CLI will prompt you, saying that the SSM Agent is already registered. This is the expected response, and the code that you already pasted will have already prompted the system to continue.
You will notice that the final line states "Successfully registered the instance with AWS." This means that the SSH method has successfully completed its portion of the SSM Agent install.
Return to the Sardius Control Panel and click "Next" to advance to Step 4.
Step 4
The Sardius Control Panel will confirm that the connection is set and that the device is ready for use. Click "Finish Pairing" to complete the process.
Your Elemental will then appear in the Devices library. Open the device to verify that all information is correct.
Items you will see will include:
- The Serial Number
- IP Address
- Firmware Version
- Memory and CPU usage
- Details related to User Authentication, and the ability to enable/disable it
- Any existing channels
Congratulations!
You have successfully paired your Elemental with the Sardius Control Panel. You are now ready to start streaming to a Sardius Channel!