@norgate-av/crestron-ch5-helper
TypeScript icon, indicating that this package has built-in type declarations

1.2.0 • Public • Published

Crestron CH5 Helper 💪

ch5-logo

CI Conventional Commits Commitizen friendly GitHub contributors NPM MIT license


This library defines all the Crestron CH5 signal types and reserved joins into a convenient Javascript object to aid in the development of CH5 projects.

All of the joins defined in this library can be found in the Crestron CH5 Reserved Join Database.

For more information, check out the CH5 Reserved Join Documentation.

Contents 📖

Installation

npm install @norgate-av/crestron-ch5-helper

# or

yarn add @norgate-av/crestron-ch5-helper

Usage 🚀

import { publishEvent, subscribeState } from "@crestron/ch5-crcomlib";
import CrestronCH5 from "@norgate-av/crestron-ch5-helper";

subscribeState(
	CrestronCH5.SignalType.Digital,
	CrestronCH5.ReservedJoin.Digital.State.Csig_All_Control_Systems_Online_fb,
	(value: boolean) =>
		console.log(`Control System ${value ? "Online" : "Offline"}`),
);

publishEvent(
	CrestronCH5.SignalType.Serial
	CrestronCH5.ReservedJoin.Serial.Event.Csig_Browser_URL,
	"https://www.npmjs.com/package/@norgate-av/crestron-ch5-helper"
);

Team

This project is maintained by the following person(s) and a bunch of awesome contributors.


Damien Butt

Contributors

All Contributors

Thanks go to these awesome people (emoji key):


Dependabot

🚧

This project follows the all-contributors specification. Contributions of any kind are welcome!

LICENSE ⚖️

MIT

Install

npm i @norgate-av/crestron-ch5-helper

DownloadsWeekly Downloads

25

Version

1.2.0

License

MIT

Unpacked Size

213 kB

Total Files

24

Last publish

Collaborators

  • damienbutt