PepperDash.Essentials.Plugins.Tuner.Vytio.Iptv 0.2.0-development.2

Vytio IPTV Tuner Plugin (c) 2025

License

Provided under MIT license

Overview

Use this repo as a template when creating a new plugin for Essentials. For more information about plugins, refer to the Essentials Wiki Plugins article.

Manually Installing Dependencies

To install dependencies once nuget.exe is installed, after cloning the template or creating your template repo, run the following command:

nuget install .\packages.config -OutputDirectory .\packages -excludeVersion

Verify you are using the proper "\" or "/" per the console used. To verify that the packages installed correctly, open Essentials and make sure that all references are found, then try and build it. This issue will be found when using WSL on Windows10.

Once the nuget package has been installed locally you will need to update your project references.

1. Right click on References
2. Select Add Reference
3. Browse to the packages folder
4. Select the required references.

Installing Different versions of PepperDash Essentials

If you need a different version of PepperDash Essentials, use the command:

nuget install PepperDashEssentials -OutputDirectory .\packages -excludeVersion -Version {versionToGet}

Omitting the -Version option will pull the latest version available.

Github Actions

Github Action workflow Templates will build this project automatically. Any branches named feature/*, release/*, hotfix/* or development will automatically be built with the action and create a release in the repository with a version number based on the latest release on the main branch. If there are no releases yet, the version number will be 0.0.1. The version number will be modified based on what branch triggered the build:

• feature branch builds will be tagged with an alpha descriptor, with the Action run appended: 0.0.1-alpha-1
• development branch builds will be tagged with a beta descriptor, with the Action run appended: 0.0.1-beta-2
• release branches will be tagged with an rc descriptor, with the Action run appended: 0.0.1-rc-3
• hotfix branch builds will be tagged with a hotfix descriptor, with the Action run appended: 0.0.1-hotfix-4

Builds on the Main branch will ONLY be triggered by manually creating a release using the web interface in the repository. They will be versioned with the tag that is created when the release is created. The tags MUST take the form major.minor.revision to be compatible with the build process. A tag like v0.1.0-alpha is NOT compatabile and may result in the build process failing.

To trigger a Main branch build follow the steps:

1. Click Releases on the left of the repo file window.
2. On the Releases page, click the Draft a new release" button on the right.
3. Enter a Tag version in the form major.minor.
4. Select the Target, typically this will be the Main branch.
5. Enter a Release title, typically this will be the same as the Tag version.
6. Click Publish Release

Device Specific Information

All commands are sent to the Vytio server. The server will pass the command to the IPTV client associated with the consoleId as defined.

Communication Settings

Plugin Valid Type Names

vytioiptv

Plugin Valid Communication methods

http

Plugin Configuration Object

Update the configuration object as needed for the plugin being developed.

{
	"devices": [
		{
			"key": "tuner-1",
			"name": "Vytio IPTV Tuner",
			"type": "vytioiptv",
			"group": "pluginDevices",
			"properties": {
				"control": {
					"method": "http",
					"tcpSshProperties": {
						"address": "10.1.2.3",
						"port": 80,
						"username": "",
						"password": "",
						"autoReconnect": false,
						"autoReconnectIntervalMs": 10000
					}
				},
				"consoleId": 2006
			}
		}
	]
}

Plugin Bridge Configuration Object

Update the bridge configuration object as needed for the plugin being developed.

{
	"devices": [
		{
			"key": "device-bridge-1",
			"name": "Essentials Device Bridge",
			"group": "api",
			"type": "eiscApiAdvanced",
			"properties": {
				"control": {
					"ipid": "B0",
					"tcpSshProperties": {
						"address": "127.0.0.2",
						"port": 0
					}
				},
				"devices": [
					{
						"deviceKey": "tuner-1",
						"joinStart": 1
					}
				]
			}
		}
	]
}

SiMPL EISC Bridge Map

The selection below documents the digital, analog, and serial joins used by the SiMPL EISC. Update the bridge join maps as needed for the plugin being developed.

Digitals

Analogs

Serials