mirror of
https://github.com/PepperDash/Essentials.git
synced 2026-01-11 19:44:52 +00:00
Lots of stuff
hvolmer
42
Home.md
42
Home.md
@@ -1,6 +1,10 @@
|
||||
# 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.
|
||||
|
||||
|
||||
PepperDash Essentials is an open-source framework for control systems, built on Crestron's Simpl# Pro framework. It can be configured as a standalone program capable of running a wide variety of system designs and can also be used to augment other Crestron programs.
|
||||
|
||||
Essentials is a collection of C# libraries that can be used in many ways. It is a 100% configuration-driven framework that can be extended to add different workflows and behaviors, either through the addition of new device-types and classes, or via a plug-in mechanism. The framework is a collection of things that are all related and interconnected, but in general do not have strong dependencies on each other.
|
||||
|
||||
---
|
||||
## Get started
|
||||
@@ -8,16 +12,42 @@ Essentials is framework for Crestron control system software development, built
|
||||
* [Download essentials build or clone repo](Get-started#)
|
||||
* [How to get started](Get-started)
|
||||
|
||||
Or use the links to the right to navigate our documentation.
|
||||
|
||||
---
|
||||
|
||||
## Benefits
|
||||
|
||||
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>
|
||||
* Increased hardware overhead compared to S+ and Simpl solutions
|
||||
* Quick development cycle
|
||||
* Shared resources made easily available
|
||||
* More flexibility with less code
|
||||
* Configurable using simple JSON files
|
||||
* Is awesome
|
||||
|
||||
Click here to see more benefit examples
|
||||
|
||||
---
|
||||
|
||||
## Documentation
|
||||
|
||||
Click the links to the right to explore Essentials further!
|
||||
|
||||
---
|
||||
|
||||
## Comment
|
||||
|
||||
The Essentials wiki 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 or suggestions for the documentation, please file an issue here, with as much detail as you can provide: <https://github.com/PepperDash/Essentials/issues>
|
||||
|
||||
Thanks!
|
||||
|
||||
---
|
||||
|
||||
## Open source collaborative workflow
|
||||
## Collaboration
|
||||
|
||||
Essentials is an open-source project and we encourage collaboration on this community project. For features that may not be useful to the greater community, or for just-plain learning, we want to remind developers to try writing plugins for Essentials. More information can be found here: [Plugins](Plugins)
|
||||
|
||||
### Open-source-collaborative workflow
|
||||
|
||||
The `master` branch always contain the latest stable version. The `development` branch is used for most development efforts.
|
||||
|
||||
@@ -28,6 +58,6 @@ The `master` branch always contain the latest stable version. The `development`
|
||||
- Example: `feature/add-awesomeness`,`bugfix/wow-im-dumb` or `hotfix/really-big-oops`
|
||||
- When working on a new feature or bugfix, branch from the `development` branch. When working on a hotfix, branch from `master`.
|
||||
3. Make commits as necessary (often is better). And use concise, descriptive language, leveraging issue notation and/or [Closing Keywords](https://help.github.com/articles/closing-issues-using-keywords) to ensure any issues addressed by your work are referenced accordingly.
|
||||
3. When the scope of the work for your branch is complete, make sure to rebase your branch in case further progress has been made since the repo was forked
|
||||
4. Create a Pull Request to pull your branch into the appropriate branch in the main repository.
|
||||
5. Your Pull Request will be reviewed by our team and evaluated for inclusion into the main repository.
|
||||
4. When the scope of the work for your branch is complete, make sure to rebase your branch in case further progress has been made since the repo was forked
|
||||
5. Create a Pull Request to pull your branch into the appropriate branch in the main repository.
|
||||
6. Your Pull Request will be reviewed by our team and evaluated for inclusion into the main repository.
|
||||
@@ -1,21 +1,19 @@
|
||||
# Standalone Application
|
||||
# Standalone application
|
||||
|
||||
The primary purpose for Essentials was to be used as a standalone SIMPL# Pro control system application.
|
||||
Essentials was originally designed as a standalone SIMPL# Pro control system application and has developed into a versatile, pluggable application. This page describes how to use our built-in room types for a completely self-contained "one-slot" control program.
|
||||
|
||||
By using a JSON configuration file to define the devices and room type(s), the application can control an entire AV control system for a room.
|
||||
By defining devices and a room in a JSON configuration file, Essentials can control an entire AV control system for a room. A file can be manually created in an IDE such as Visual Studio Code, or it can be generated by a friendly web-based configuration tool on [PepperDash Portal](http://pepperdash.com/products/), or some other configuration tool application, both requiring no knowledge of JSON. These tools step a user through building the necessary devices and setting to achieve a full working room.
|
||||
|
||||
The configuration file can be generated by a friendly configuration tool application which requires no knowledge of JSON. It steps through building the necessary devices and configuration to achieve a fully working room.
|
||||
## Included standalone room types
|
||||
- `EssentialsHuddleSpaceRoom` - Presentation-only Huddle Room
|
||||
- Single display device
|
||||
- Use the display's speakers or another device for audio
|
||||
- Any number of presentation sources
|
||||
- Fusion Room and Static Asset integration with device usage tracking and schedule awareness
|
||||
- Occupancy Sensor integration with vacancy shutdown
|
||||
- Audio/video routing via Crestron DM hardware
|
||||
|
||||
## Supported Room Types
|
||||
- `EssentialsHuddleSpaceRoom` - The standard Presentation only Huddle Room
|
||||
- Supports a single display device
|
||||
- Supports using the display's speakers or another device for audio
|
||||
- Supports any number of presentation sources
|
||||
- Supports Fusion Room and Static Asset integration with device usage tracking and schedule awareness
|
||||
- Supports Occupancy Sensor integration with vacancy shutdown
|
||||
- Supports audio/video routing via Crestron DM hardware
|
||||
|
||||
- `EssentialsHuddleVtc1Room` - The standard single display ATC/VTC capable Huddle Room
|
||||
- `EssentialsHuddleVtc1Room` - Single-display ATC/VTC capable Huddle Room
|
||||
- All of the above, plus:
|
||||
- Audio calling via a DSP/Audio Codec or Video Codec
|
||||
- Video calling via a Video Codec
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
* [Home](Home)
|
||||
|
||||
**Get started**
|
||||
* Get Essentials
|
||||
* How to get started
|
||||
* [Get Essentials](Get-started#download-or-clone)
|
||||
* [How to get started](Get-started#how-to)
|
||||
|
||||
**Technical documentation**
|
||||
|
||||
|
||||
Reference in New Issue
Block a user