Documentation: Difference between revisions

From The Kinguard Project Wiki
Jump to navigation Jump to search
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Manual Source ==
The manual for the is written in latex and located on [https://github.com/Kinguard/manual github]
Ideally this should be adapted to better suit The Kinguard Project, so feel free to contribute.
In order for this to work, there are separate branches for different products and also a separate branch for a short one-pager.
== OPI ==
== OPI ==


=== Manual ===
The latest compiled version is available [https://download.openproducts.com/opi/documentation/quickstart.pdf as pdf here]
The latest compiled version is available [https://download.openproducts.com/opi/documentation/quickstart.pdf as pdf here]
=== Schematics ===
The schematics for OPI is available for download [https://download.openproducts.com/opi/documentation/OP-I_1B Rev B .pdf as pdf here]. It is in most aspects a copy of BeageBoneBlack, with the HDMI removed.


== KEEP ==
== KEEP ==


=== Manual ===
The latest compiled version is available [https://download.openproducts.com/keep/documentation/keep-quickstart.pdf as pdf here]
The latest compiled version is available [https://download.openproducts.com/keep/documentation/keep-quickstart.pdf as pdf here]


== SOURCE ==
=== Schematics ===
The manual for the is written in latex and located on [https://github.com/Kinguard/manual github]
KEEP is using a SOM (System On Module) from SolidRun, with 2GB DDR RAM and 8GB eMMC. The carrier board is made by [https://www.openproducts.com OpenProducts]. Schematics and component placement for that board is available [https://download.openproducts.com/keep/documentation/KEEP_R1B.pdf as pdf here].
Ideally this should be adapted to better suit The Kinguard Project, so feel free to contribute.
 
[https://download.openproducts.com/keep/documentation/KEEP_PCB.step A stp-model] for the PCBA is also available for download (~60MB).


In order for this to work, there are seperate branches for different products and also a separate branch for a short one-pager.
== Developer documentation ==
=== Software components ===
There are a number of software components available in The Kinguard Project, some of them documented here, but most is by comments in source code and available by running the application with "--help"
* System configuration (sysconfig.json). [[Documentation/sysconfig|Details]]
* System utilities, (kgp-sysinfo, kgp-notifier) [https://github.com/Kinguard/kinguard-utils Details]

Latest revision as of 07:45, 6 June 2018

Manual Source

The manual for the is written in latex and located on github Ideally this should be adapted to better suit The Kinguard Project, so feel free to contribute.

In order for this to work, there are separate branches for different products and also a separate branch for a short one-pager.

OPI

Manual

The latest compiled version is available as pdf here

Schematics

The schematics for OPI is available for download Rev B .pdf as pdf here. It is in most aspects a copy of BeageBoneBlack, with the HDMI removed.

KEEP

Manual

The latest compiled version is available as pdf here

Schematics

KEEP is using a SOM (System On Module) from SolidRun, with 2GB DDR RAM and 8GB eMMC. The carrier board is made by OpenProducts. Schematics and component placement for that board is available as pdf here.

A stp-model for the PCBA is also available for download (~60MB).

Developer documentation

Software components

There are a number of software components available in The Kinguard Project, some of them documented here, but most is by comments in source code and available by running the application with "--help"

  • System configuration (sysconfig.json). Details
  • System utilities, (kgp-sysinfo, kgp-notifier) Details