CH5 - Crestron Components library (CrComLib) - Getting Started
See Crestron developer website for documentation
https://www.crestron.com/developer Search for CRESTRON HTML5 USER INTERFACE
Generated folders
- build_bundles/module_type - contains files generated by webpack (and the typescript compiler for the esm modules)
- compiled_bundles/module_type - contains files generated by the typescript compiler (tsc)
- docs/html
Where module_type is:
- umd - UMD (contains CommonJs, AMD, and also creates a global property in the window object).
- cjs - CommonJs
- esm - ES Modules, ES6.
- amd - Asynchronous Module Definition
Activating extra information in the browser console
For ch5 components
Ch5 components will display additional info in the browser console if they have a debug attribute defined. For example:
<ch5-button debug label="Btn1"></ch5-button>
For ch5 custom attributes (data-ch5-...)
Additional information will be displayed in the browser console if the element has a debug attribute. For example:
<div debug data-ch5-show="a_signal">Hello</div>
For the bridge-related functions/methods
In order to display additional information, you must first enable this using the methods from Ch5Debug:
- getConfig - Returns the current configuration: all keys that can be set and their current value. A key enables debug info for a method/function
- loadConfig(cfg) - Loads a new config (replaces the previous one)
- enableAll() - Enables all keys. Will display all debug info available. (The debug info that uses Ch5Debug, the info from ch5 components, and custom attributes will not be affected)
- disablesAll() - Disables all keys
- setConfigKeyValue(key:string, value:boolean) - Changes the value of a key
Build Dev Universal Module Definition
npm run buildumd
Run Test web-component-tester
npm run test:wct
Start
npm run start
localhost 3000 with parameters IP ID and Host
http://localhost:3000/?ipId=0x99&host=10.0.0.203
What's New
Updates to the Crestron HTML5 User Interface and documentation are avalilable in the following link https://sdkcon78221.crestron.com/sdk/Crestron_HTML5UI/Content/Topics/Whats-New.htm
npm link
cd crestron-components-lib npm link
cd CH5Sandbox\shell-template
npm link @crestron/ch5-crcomlib