Installation

3 minute read

Installation

First of all, let’s prepare the BeeYard. These steps are a quick recapitulation of what needs to be done first
1. Download the BeeYard installation package.
2. Install the BeeYard.
3. Log in to the BeeYard.
4. Create the Workspace where you want to collect data.
Add new Client

Note
The displayed Client ID is a combination of its Tenant prefix and the Client’s name.
1. Name the Client, and the Tenant will be added automatically. For example, name it "inputgw".
2. Set the roles, and for this purpose, use the 'developer' role.
  
  The 'developer' role is a predefined role that includes all the required authorities and some that are not needed for this specific use case. It is possible to create a role containing only the necessary authorities.
3. Copy the Client secret.
Prepare Tags.
1. In the Workspace settings, create new Tag templates. These Tags will be used to mark the source for uploaded data.
Proceed with the installation steps.
Download the Input Gateway package.
Unpack the zip package and place all the files into the same directory.

Open the 'appsettings.json' file.

Set the BeeYard "Ftp" client parameters if you want to upload images from an 3rd party FTP server.

Set the "Host" IP address, "Username", and the "Password". If you want to upload from the local disk, you can leave the parameters at their default values.
```
"Ftp": {
    "Host": "127.0.0.1",
    "Username": "username",
    "Password": "password"
  }
```

Set the "Hive" parameters.

Set the "HiveUri", "IdUri", "ClientId", and the "ClientSecret".

"Hive": {
    "HiveUri": "http://localhost/hive/",
    "IdUri": "http://localhost/id/",
    "ClientId": "public.inputgw",
    "ClientSecret": "secret_copied_from_the_BeeYard"
  }

Set the "Tcp" server parameters.

Set the "Host" IP address, and the "Port".

"Tcp": {
    "Enabled": true,
    "Host": "127.0.0.1",
    "Port": 1234,
    "MaxConnections": 1,
    "AllowedHosts": [
      "127.0.0.1"
    ],
    "DecimalSeparator": "."
  }

Set the "PlcFtp" parameters.

Set the global "Timeout", all the "Tag", "Categories" and "Names", and for each "Camera" set "UseFtp", "Folder", and "ImageName".

"PlcFtp": {
    "Enabled": true,
    "TimeoutMs": 5000,
    "Tag": {
      "Category": "input_gateway.device",
      "Name": "input_gateway"
    },
    "Plc": {

      "Tag": {
        "Category": "input_gateway.device",
        "Name": "plc"
      }
    },
    "Cameras": [
      {
        "Tag": {
          "Category": "input_gateway.device",
          "Name": "camera1"
        },
        "UseFtp": true,
        "Folder": "/camera1",
        "ImageName": "image.jpg"
      }
    ]
  }

Set the "Urls".
```
"Urls": "http://localhost:5001"
```
The "ReportMetrics", "AllowedHosts", and "Serilog" do not require editing.

Run the FTP server if you want to upload images from a camera device. For uploading data from the local disk, an FTP server is not required.
Open the console, such as Command Prompt or PowerShell.
Change the directory to the location with the InputGateway executable file and the application settings json file.

Command Prompt, PowerShell

cd C:\BeeYard_Input_Gateway
Run the Input Gateway exe file.

Command Prompt

InputGateway.exe

PowerShell

.\InputGateway.exe