Sharp Display Essentials Plugin (c) 2021

Overview

This plugin is designed to work with Sharp Displays controlled via TCP/IP or RS-232. For config information, see the config snippets

Configuration

RS-232

{
  "key": "display-1",
  "uid": 4,
  "type": "sharpDisplay",
  "name": "Display",
  "group": "display",
  "properties": {
    "control": {
      "controlPortDevKey": "processor",
      "controlPortNumber": 1,
      "method": "com",
      "comParams": {
        "protocol": "RS232",
        "baudRate": 9600,
        "hardwareHandshake": "None",
        "softwareHandshake": "None",
        "dataBits": 8,
        "parity": "None",
        "stopBits": 1
      }
    },
    "zeroPadCommands": false,
    "noPadding": false,
    "volumeUpperLimit": 100,
    "volumeLowerLimit": 0,
    "pollIntervalMs": 60000,
    "pollVolume": false,
    "coolingTimeMs": 15000,
    "warmingTimeMs": 15000
  }
}

TCP/IP

{
  "key": "display-1",
  "uid": 4,
  "type": "sharpDisplay",
  "name": "Display",
  "group": "display",
  "properties": {
    "control": {
      "method": "tcpIp",
      "tcpSshProperties": {
        "port": 22,
        "address": "0.0.0.0",
        "username": "",
        "password": "",
        "autoReconnect": true,
        "autoReconnectIntervalMs": 5000,
        "bufferSize": 32768
      }
    },
    "zeroPadCommands": true,
    "noPadding": false,
    "volumeUpperLimit": 100,
    "volumeLowerLimit": 0,
    "pollIntervalMs": 60000,
    "pollVolume": false,
    "coolingTimeMs": 15000,
    "warmingTimeMs": 15000
  }
}

Pad Commands

Optional boolean value to configure if commands should be padded with zeros. If not present defaults to padding commands with " " (\x20).

Commands without Zero Pad

Configuration

"zeroPadCommands": false,

Command Structure

"POWR   1\x0D0A";

Commands with Zero Pad

Configuration

"zeroPadCommands": true,

Command Structure

"POWR0001\x0D\x0A";

Commands with No Padding

Configuration

"noPadding": true,

Command Structure

"POWR1\x0D\x0A";

License

Provided under MIT License

Contributing

Dependencies

The Essentials libraries are required. They are referenced via nuget. You must have nuget.exe installed and in the PATH environment variable to use the following command. Nuget.exe is available at nuget.org.

Installing Dependencies

To install dependencies once nuget.exe is installed, run the following command from the root directory of your repository: nuget install .\packages.config -OutputDirectory .\packages -excludeVersion. To verify that the packages installed correctly, open the plugin solution in your repo and make sure that all references are found, then try and build it.

Installing Different versions of PepperDash Core

If you need a different version of PepperDash Core, use the command nuget install .\packages.config -OutputDirectory .\packages -excludeVersion -Version {versionToGet}. Omitting the -Version option will pull the version indicated in the packages.config file.