diff --git a/Get-started.md b/Get-started.md index 3256251..7147604 100644 --- a/Get-started.md +++ b/Get-started.md @@ -6,19 +6,19 @@ You may clone Essentials at -## How to +## How to Get Started This section assumes knowledge of loading programs to and working with the file system on a Crestron processor. To help understand Essentials Framework, we recommend starting with the current [Release build](https://github.com/PepperDash/Essentials-Builds) and loading it to a Crestron 3-Series processor. -1. First, load the PepperDashEssentials.cpz to the processor in program slot 1 and start the program. +1. Load the PepperDashEssentials[version].cpz to the processor in program slot 1 and start the program by sendign console command `progload -p:1` 1. On first boot, the Essentials Application will build the necessary configuration folder structure in the User/Program1/ path. -1. Load the ReleaseEssentialsConfigurationFile.json to the User/Program1/ folder. -1. Reset the program via console (progreset -p:1). The program will load the example configuration file. +1. Load `'Example Configuration/EssentialsHuddleRoom/configurationFile-HuddleSpace-2-Source.json'` to the User/Program1/ folder. +1. Reset the program via console `progreset -p:1`. The program will load the example configuration file. 1. Launch the EssentialsExampleXpanel.vtz project. You can interact with the program (which uses simulated device logic to emulate a real commercial huddle room with presentation, audio and video calling capabilities). -1. Via console, you can run the (devlist:1) command to get some insight into what has been loaded from the configuration file into the system . This will print the basic device information in the form of ["key"] "Name". The "key" value is what we can use to interact with each device uniquely. -1. Run the command (devprops:1 display-1). This will print the real-time property values of the device with key "display-1". -1. Run the command (devmethods:1 display-1). This will print the public methods available for the device with key "display-1". -1. Run the command (devjson:1 {"deviceKey":"display-1","methodName":"PowerOn", "params": []}). This will call the method PowerOn() on the device with key "display-1". +1. Via console, you can run the `devlist:1` command to get some insight into what has been loaded from the configuration file into the system . This will print the basic device information in the form of ["key"] "Name". The "key" value is what we can use to interact with each device uniquely. +1. Run the command `devprops:1 display-1`. This will print the real-time property values of the device with key "display-1". +1. Run the command `devmethods:1 display-1`. This will print the public methods available for the device with key "display-1". +1. Run the command `devjson:1 {"deviceKey":"display-1","methodName":"PowerOn", "params": []}`. This will call the method PowerOn() on the device with key "display-1".