Skip to content

Commit

Permalink
Merge pull request #618 from rafaelabranchesskyline/main
Browse files Browse the repository at this point in the history
CNA-2 and MLS-X1 driver help pages
  • Loading branch information
MariekeGO authored Jan 7, 2025
2 parents 8569ffd + 2c1106c commit 6d5a23e
Show file tree
Hide file tree
Showing 3 changed files with 176 additions and 0 deletions.
72 changes: 72 additions & 0 deletions connector/doc/Sony_CNA-2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
uid: Connector_help_Sony_CNA-2
---

# Sony CNA-2

Sony CNA-2 is a camera control network adaptor that is able to monitor, configure, and control Sony system cameras anywhere within the network. It is able to run productions to get the most out of the system cameras and visualize grouping functions and settings for SR-Live and Networked Live.

## About

### Version Info

| Range | Features | Based on | System Impact |
|--------------------|----------------------------------------------------------------|----------|---------------|
| 1.0.0.x [SLC Main] | - System camera management<br>- Webhook listening capabilities | - | - |

### Product Info

| Range | Supported Firmware |
|---------|--------------------|
| 1.0.0.x | v1.0820 |

### System Info

| Range | DCF Integration | Cassandra Compliant | Linked Components | Exported Components |
|---------|-----------------|---------------------|-------------------|---------------------|
| 1.0.0.x | No | Yes | - | - |

## Configuration

### Connections

#### HTTP Connection

This connector uses an HTTP connection and requires the following input during element creation:

HTTP CONNECTION:

- **IP address/host**: The polling IP or URL of the destination.
- **IP port**: The IP port of the destination (default: *443*).
- **Device address**: The bus address of the device. If the proxy server has to be bypassed, specify *BypassProxy*.

### Initialization

On the **Communication Settings** page, you will need to provide a username and a password to log in to the device.

#### Webhook Listener

This connector uses an HTTP listener and requires the following configuration within the element:

WEBHOOK LISTENER:

- **Webhook IP**: The IP used to listen to webhooks.
- **Webhook port**: The port used to listen to webhooks (default: *50000*; needs to be opened in the firewall).

### Web Interface

The web interface is only accessible when the client machine has network access to the product.

## How to use

This connector uses REST API calls to communicate with the device.

It has two communication modes, GMCS and MCS.

- In **GMCS** mode, you can configure up to 10 different domains with 3 tables each, one for CCU device information, one for CCU Assignment information, and one for RCP Assignment information. The domains can be enabled/disabled in the **GMCS Communication Settings** table on the **Communication Settings** page. This will also affect whether a domain is polled and displayed or not.

- When in **MCS** mode, you will only have access to one domain with the same 3 tables.

- For both modes, a matrix for CCU assignments and another for RCP assignments is available.

The webhook communication is responsible for receiving updates on connections made, so it is important to make sure that you provide valid webhook connection parameters. An incorrect configuration will lead to tables and matrices only being updated every 15 minutes. It is also important to ensure that the webhook port is opened in the firewall, as otherwise no webhook communication will be received.
100 changes: 100 additions & 0 deletions connector/doc/Sony_MLS-X1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
---
uid: Connector_help_Sony_MLS-X1
---

# Sony MLS-X1

The Modular Live System (MLS-X1) is a production switcher platform. It can be configured to meet a wide range of live production requirements, and it provides processing power and scalability to enhance production environments.

The MLS-X1 inherits the operability, reliability, and capability of other Sony professional switchers. It uses multiple smaller processing units that can be rapidly configured according to the requirements of any production. This allows you to cater for large-scale events, including multi-program and multi-format productions, and it provides the agility to meet future demands.

## About

### Version Info

| Range | Features | Based on | System Impact |
|--------------------|-------------------------------------------------------------------------|----------|---------------|
| 1.0.0.x [SLC Main] | - System monitoring through SNMP<br>- System configuration through gRPC | - | - |

### Product Info

| Range | Supported Firmware |
|---------|--------------------|
| 1.0.0.x | - |

### System Info

| Range | DCF Integration | Cassandra Compliant | Linked Components | Exported Components |
|---------|-----------------|---------------------|-------------------|---------------------|
| 1.0.0.x | Yes | Yes | - | - |

## Configuration

### Connections

#### SNMP Connection

This connector uses a Simple Network Management Protocol (SNMP) connection and requires the following input during element creation:

SNMP CONNECTION:

- **IP address/host**: The polling IP or URL of the destination.
- **IP port**: The IP port of the destination (default: *161*).

SNMP Settings:

- **Get community string**: The community string used when reading values from the device (default: *public*).
- **Set community string**: The community string used when setting values on the device (default: *private*).

### Initialization

This connector also uses gRPC (Google Remote Procedure Call) to manage and configure the system. It will use up to 5 gRPC connections to gather information and to configure the different systems, which will need to be configured in the element.

#### Manager gRPC Connection

On the **MLS Manager** page, configure the following parameters for the Manager gRPC connection:

- **IP address/Hostname**: The IP of the destination (default: *Polling IP*).
- **IP port**: The IP port of the destination (default: *31042*).
- **Username**: The login username.
- **Password**: The login password.

#### Logical Switcher gRPC Connection

On the **Logical Switcher** page, configure the following parameters:

Logical Switcher gRPC Connection:

- **IP port**: The IP port of the destination (default: *9181*). You can obtain this from the **System Configurations** table on the **MLS Manager** page.
- **Username**: The login username.
- **Password**: The login password.

### Web Interface

The web interface is only accessible when the client machine has network access to the product.

## How to use

- **General**: This page contains general information, such as the **System Description**, **System Up Time**, **System Contact**, **Name**, and **Location**. It also displays an overview of the **OSI Model** of the availability of each layer, as well as the Agent and Switcher **MIB Versions**.
- **Network**: This page displays the **Interfaces** and **Address Translation** tables. The Interfaces table displays the operational status of the interfaces available in the workstation. This operational status can also change based on incoming traps.
- **Product Information**: This page displays the **Product Information**, **Modules**, and **Remote Maintenance** tables.
- **Traps**: This page displays the **Traps Destination** table.
- **Alarms**: This page displays the **Error Status** table. This table is cleared when a "Coldstart" trap is received.
- **XVS Control**: This page allows you to check which XVS element is connected to which XVS via the **Control Interfaces** table. There is a **Resubscribe** button to reset all the created subscriptions.
- **Subscriptions**: This page allows you to check all the subscriptions created by this element.
- **Agent MIB**: This page displays the **Agent MIB Categories** and **Agent MIB Products** tables.
- **Switcher Information**: This page displays the **Switcher Reference Information**, **Switcher Temperature Information**, **Switcher Fan Information**, **Switcher Power Sensors**, **Switcher SSD Information**, and **Switcher Battery Information** tables.
- **MLS Manager**: This page displays the **MLS Manager** gRPC connection credentials and state, as well as some system settings.
- **Logical Switcher**: This page displays the **Logical Switcher** gRPC connections. It also displays some information about each connection and connected device.

## DataMiner Connectivity Framework

The **1.0.0.x** range of the Sony MLS-X1 connector supports the usage of DCF.

DCF can also be implemented through the DataMiner DCF user interface and through third-party DataMiner connectors (e.g. a manager).

### Interfaces

#### Dynamic interfaces

- In the Interfaces table, dynamic interfaces are available with type **inout**.
4 changes: 4 additions & 0 deletions connector/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8297,6 +8297,8 @@
topicUid: Connector_help_Sony_CNA-1_-_CCU
- name: Sony CNA-1 - RCP
topicUid: Connector_help_Sony_CNA-1_-_RCP
- name: Sony CNA-2
topicUid: Connector_help_Sony_CNA-2
- name: Sony HDCU-3000 Series
topicUid: Connector_help_Sony_HDCU-3000_Series
- name: Sony Location Manager
Expand All @@ -8307,6 +8309,8 @@
topicUid: Connector_help_Sony_MKS-R4020
- name: Sony MKS Remote Control Panel
topicUid: Connector_help_Sony_MKS_Remote_Control_Panel
- name: Sony MLS-X1
topicUid: Connector_help_Sony_MLS-X1
- name: Sony MSU-3000 Series
topicUid: Connector_help_Sony_MSU-3000_Series
- name: Sony NMI Device
Expand Down

0 comments on commit 6d5a23e

Please sign in to comment.