-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
529b333
commit 914dceb
Showing
59 changed files
with
8,549 additions
and
11,796 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# CORE Applications | ||
|
||
Clover relies on a few included applications that are used to provide expected functionality on a base system. Plus, there's a few extras to help you explore the possibilities. |
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Applications | ||
|
||
Clover relies on a few included applications that are used to provide expected functionality on a base system. Plus, there's a few extras to help you explore the possibilities. | ||
|
||
## App Directory | ||
|
||
| Name | Description | ID | | ||
|-|-|-| | ||
| Main | Provides the initial intent that Clover uses for expression replication, launching other applications, and handling user input. | `com.reboot-codes.clover.core.main` | | ||
| Settings | More in-depth settings, but not as advanced as [Spanner](/docs/components/spanner/intro). | `com.reboot-codes.clover.core.settings` | |
File renamed without changes.
7 changes: 7 additions & 0 deletions
7
docs/docs/components/CORE/applications/main/expression-replication.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Expression Replication | ||
|
||
Use a sensor fusion model to replicate the user's expressions by manipulating other modules. | ||
|
||
## Facial Expressions | ||
|
||
In CORE, facial expressions can be replicated with a single [display](/docs/components/clover-hub/server/modman/modules/components/display), multiple displays, or by manipulating [Movement Components](/docs/components/clover-hub/server/modman/modules/components/movement) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Main | ||
|
||
Provides the initial intent that Clover uses for expression replication, launching other applications, and handling user input. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Settings | ||
|
||
More in-depth settings, but not as advanced as [Spanner](/docs/components/spanner/intro). |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Expression Packs | ||
|
||
Provides default dynamic expression animations for [The expression replicator](/docs/components/core/applications/main/expression-replication). |
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Modules | ||
|
||
Modules personally used by Reboot/Fitz that are designed to be extended by the users of Clover. | ||
|
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
3 changes: 3 additions & 0 deletions
3
docs/docs/components/clover-hub/server/inference-engine/_category_.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
link: | ||
type: doc | ||
id: intro |
File renamed without changes.
File renamed without changes.
3 changes: 3 additions & 0 deletions
3
docs/docs/components/clover-hub/server/modman/_category_.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
link: | ||
type: doc | ||
id: intro |
File renamed without changes.
3 changes: 3 additions & 0 deletions
3
docs/docs/components/clover-hub/server/modman/modules/_category_.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
link: | ||
type: doc | ||
id: intro |
3 changes: 3 additions & 0 deletions
3
docs/docs/components/clover-hub/server/modman/modules/components/_category_.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
link: | ||
type: doc | ||
id: intro |
1 change: 1 addition & 0 deletions
1
docs/docs/components/clover-hub/server/modman/modules/components/display.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Display |
9 changes: 9 additions & 0 deletions
9
docs/docs/components/clover-hub/server/modman/modules/components/intro.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Components | ||
|
||
Modules expose components which are registered as different types. | ||
|
||
## Display | ||
|
||
Display components are registered with modman, and are then passed onto the [renderer](/docs/components/clover-hub/server/renderer/intro) to receive frames over [EvtBuzz](/docs/components/clover-hub/server/evtbuzz/intro). | ||
|
||
## Movement |
1 change: 1 addition & 0 deletions
1
docs/docs/components/clover-hub/server/modman/modules/components/movement.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Movement |
3 changes: 3 additions & 0 deletions
3
docs/docs/components/clover-hub/server/modman/modules/intro.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Modules | ||
|
||
Modules can comprise multiple components, and are responsible for exposing available components via a provided [API Key](/docs/components/clover-hub/server/evtbuzz/auth). |
3 changes: 3 additions & 0 deletions
3
docs/docs/components/clover-hub/server/renderer/_category_.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
link: | ||
type: doc | ||
id: intro |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
link: | ||
type: doc | ||
id: intro |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Components | ||
|
||
These are the core components that make up Clover's base. | ||
|
||
## CloverHub | ||
|
||
The Rust-based nerve centre for all communication between modules, their components, you, and configuration tools. It is built to be secure and performant, while allowing for flexible implementation for everything from spicing up your cosplay, to surgical body mods. | ||
|
||
## CORE | ||
|
||
Sensible default applications, lovingly designed parts, and dynamic expression packs to get you started. All parts are build using best-practices, and are considered to be fully supported and used as an immutable fallback when it comes to software. | ||
|
||
## Spanner | ||
|
||
Advanced configuration application that enables full control and composition of connected modules. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
link: | ||
type: doc | ||
id: intro |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
link: | ||
type: doc | ||
id: intro |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Desktop | ||
|
||
The spanner desktop app is designed for easy configuration of Clover, including initial installation of clover. |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
link: | ||
type: doc | ||
id: intro |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# SpannerLib | ||
|
||
Spanner lib is designed to provide a well documented and safe interface for connecting to Clover. It's written in rust and will eventually provide bindings for several languages. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Bill of Materials | ||
|
||
- A single board computer | ||
- Optional, but HIGHLY suggested when using expression recreation: A Tensor Processing Unit (or something that can serve as one, a GPU on the SBC will work, otherwise [refer to Taurus' TPU support](https://taurus.reboot-codes.com/)). | ||
- Optional, but suggested: Bluetooth Module (as long as the SBC has one and the OS has drivers for it, you'll be fine) | ||
- Optional, but suggested: WLAN module (same as above, Hub uses the OS's IP stack) | ||
- Body-safe Battery | ||
- Reboot/Fitz mainly uses a belt-mounted LiPo battery pack (see: [CORE's modules](/docs/components/CORE/modules/intro)), but you can use just about anything that'll: | ||
- Not explode when you go outside in the weather. | ||
- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
link: | ||
type: doc | ||
id: intro |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Prerequisites | ||
|
||
Clover is a very complex system, and you'll need to make a few decisions before you can begin to set it up. | ||
|
||
[CORE](/docs/components/core/intro) is provided to give you a maintainer-supported platform to use and later expand upon. Or you can start with your own hardware, and reference this guide as you build and design your own components. | ||
|
||
However, in general, you'll need: | ||
|
||
- An SBC | ||
- Some micro controllers (one per module) | ||
- A couple of motors, servos, leds, etc. | ||
- Access to a 3D printer. | ||
- And a computer. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
link: | ||
type: doc | ||
id: intro |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.