pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-01-11 19:44:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Further stuff

hvolmer
2020-02-12 14:50:46 -07:00
parent ca9eb03863
commit e42d5e9e8a
3 changed files with 53 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
Get-started.md Normal file

@@ -0,0 +1,24 @@
# Get started
## Download or clone
You may clone Essentials at <https://github.com/PepperDash/Essentials/tree/master>
You may download ready-to-run Essentials at <https://github.com/PepperDash/Essentials-Builds>
## How to
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. 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. 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".

15
Home.md

@@ -1,14 +1,23 @@
# Welcome to the Essentials Documentation wiki!
# Welcome to PepperDash Essentials!
Essentials is framework for Crestron control system software development, built upon the Crestron Simpl# Pro framework. It is a configuration-driven framework that can be used to create standalone programs or programs that support Simpl programs running in another program slot.
---
## Get started
* [Download essentials build or clone repo](Get-started#)
* [How to get started](Get-started)
---
This area is clearly in-progress right now. Take a look at the links to the right. We are actively working on this documentation, so please be patient with us. If you have any comments, reach out to Heath and Neil.
This area is clearly in-progress right now. Take a look at the links to the right. We are actively working on this documentation, so please be patient with us. If you have any comments on the documentation, please file an issue here: <https://github.com/PepperDash/Essentials/issues>
Thanks!
## Open Source Collaborative Workflow
---
## Open source collaborative workflow
The `master` branch always contain the latest stable version. The `development` branch is used for most development efforts.

36
_Sidebar.md

@@ -1,25 +1,21 @@
**Home**
* [Home](Home)
**Architecture**
**Get started**
* Get Essentials
* How to get started
**Technical documentation**
* [Standalone use](Standalone-Use)
* [Essentials Architecture](Essentials-Architecture)
* Subtopic
* Subtopic
# [Plugins](Plugins)
[Standalone Use](Standalone-Use)
[Device Construction and Activation Phases](Device-Construction-and-Activation-Phases)
[Communication Basics](Communication-Basics)
[Debugging](Debugging)
[Feedback Classes](Feedback-Classes)
[Connection Based Routing](Connection-Based-Routing)
[Glossary of Terms](Glossary-of-Terms)
[Supported Devices](Supported-Devices)
* Another
* [Plugins](Plugins)
* [Device Construction and Activation Phases](Device-Construction-and-Activation-Phases)
* [Communication Basics](Communication-Basics)
* [Debugging](Debugging)
* [Feedback Classes](Feedback-Classes)
* [Connection Based Routing](Connection-Based-Routing)
* [Glossary of Terms](Glossary-of-Terms)
* [Supported Devices](Supported-Devices)