pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-02-10 02:05:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Temporarily adjusted get-started language to remove Xpanel step and instead added coming soon message.

Neil Dorin
2020-02-13 20:34:55 -07:00
parent 0b90998902
commit 7ee575e504
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
Get-started.md

@@ -16,10 +16,11 @@ To help understand Essentials Framework, we recommend starting with the current
1. On first boot, the Essentials Application will build the necessary configuration folder structure in the User/Program1/ path.
1. The application has some example configuration files included. Copy `/Program01/Example Configuration/EssentialsSpaceHuddleRoom/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".
(Coming soon, a demo XPanel UI interface to interact with the system functionality)
Next: [Standalone use](Standalone-Use)