Commit 9945f286 authored by Marcus Greiff's avatar Marcus Greiff

Added revised documentation

parent a896ac43
Pipeline #573 passed with stage
in 30 seconds
File added
[![pipeline status](https://gitlab.control.lth.se/labdev/LabConnections.jl/badges/master/pipeline.svg)](https://gitlab.control.lth.se/labdev/LabConnections.jl/commits/master)
[![coverage report](https://gitlab.control.lth.se/labdev/LabConnections.jl/badges/master/coverage.svg)](https://gitlab.control.lth.se/labdev/LabConnections.jl/commits/master)
Documentation available at [Documentation](http://processes.gitlab.control.lth.se/documentation/labconnections/)
File added
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>LabConnections · LabConnections</title><link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link href="assets/documenter.css" rel="stylesheet" type="text/css"/></head><body><nav class="toc"><h1>LabConnections</h1><select id="version-selector" onChange="window.location.href=this.value" style="visibility: hidden"></select><form class="search" action="search.html"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li class="current"><a class="toctext" href="index.html">LabConnections</a><ul class="internal"></ul></li><li><a class="toctext" href="installation.html">Installation Instructions</a></li><li><a class="toctext" href="systemConfiguration.html">System Configuration</a></li></ul></nav><article id="docs"><header><nav><ul><li><a href="index.html">LabConnections</a></li></ul><a class="edit-page" href="https://github.com//tree/2f394b7fb331bde8055286d7ff760868bc3c8d27/docs/src/index.md"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>LabConnections</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="LabConnections-1" href="#LabConnections-1">LabConnections</a></h1><p>This is the documentation for the LabCommunication project, detailing installation instructions, examples and tests which may be run, as well as documenting the protocols and structure of the IO communication.</p><ul><li><a href="installation.html#Installation-Instructions-1">Installation Instructions</a></li><ul><ul><li><a href="installation.html#On-the-HOST-1">On the HOST</a></li><li><a href="installation.html#On-the-BeagleBone-1">On the BeagleBone</a></li><li><a href="installation.html#Setting-up-automatic-communication-between-the-BB-and-the-HOST-via-TCP-1">Setting up automatic communication between the BB and the HOST via TCP</a></li></ul></ul><li><a href="index.html#LabConnections-1">LabConnections</a></li><li><a href="systemConfiguration.html#System-Configuration-1">System Configuration</a></li><ul><li><a href="systemConfiguration.html#Configuration-interfaces-1">Configuration interfaces</a></li><li><a href="systemConfiguration.html#Configuration-files-1">Configuration files</a></li><li><a href="systemConfiguration.html#Creating-configurations-1">Creating configurations</a></li></ul></ul><pre><code class="language-"></code></pre><footer><hr/><a class="next" href="installation.html"><span class="direction">Next</span><span class="title">Installation Instructions</span></a></footer></article></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>LabConnections · LabConnections</title><link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link href="assets/documenter.css" rel="stylesheet" type="text/css"/></head><body><nav class="toc"><h1>LabConnections</h1><select id="version-selector" onChange="window.location.href=this.value" style="visibility: hidden"></select><form class="search" action="search.html"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li class="current"><a class="toctext" href="index.html">LabConnections</a><ul class="internal"></ul></li><li><a class="toctext" href="installation.html">Installation Instructions</a></li><li><a class="toctext" href="systemConfiguration.html">System Configuration</a></li></ul></nav><article id="docs"><header><nav><ul><li><a href="index.html">LabConnections</a></li></ul><a class="edit-page" href="https://github.com//tree/a896ac435aa1ba8ddbeecbb871aaad4bc26fbeab/docs/src/index.md"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>LabConnections</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="LabConnections-1" href="#LabConnections-1">LabConnections</a></h1><p>This is the documentation for the LabCommunication project, detailing installation instructions, examples and tests which may be run, as well as documenting the protocols and structure of the IO communication.</p><ul><li><a href="installation.html#Installation-Instructions-1">Installation Instructions</a></li><ul><li><a href="installation.html#On-the-HOST-1">On the HOST</a></li><li><a href="installation.html#On-the-BeagleBone-1">On the BeagleBone</a></li><li><a href="installation.html#Setting-up-automatic-communication-between-the-BB-and-the-HOST-via-TCP-1">Setting up automatic communication between the BB and the HOST via TCP</a></li></ul><li><a href="index.html#LabConnections-1">LabConnections</a></li><li><a href="systemConfiguration.html#System-Configuration-1">System Configuration</a></li><ul><li><a href="systemConfiguration.html#Configuration-interfaces-1">Configuration interfaces</a></li><li><a href="systemConfiguration.html#Configuration-files-1">Configuration files</a></li><li><a href="systemConfiguration.html#Creating-configurations-1">Creating configurations</a></li></ul></ul><pre><code class="language-"></code></pre><footer><hr/><a class="next" href="installation.html"><span class="direction">Next</span><span class="title">Installation Instructions</span></a></footer></article></body></html>
This diff is collapsed.
......@@ -45,7 +45,7 @@ var documenterSearchIndex = {"docs": [
"page": "Installation Instructions",
"title": "On the BeagleBone",
"category": "section",
"text": "On the BeagleBone, first install Debian for 32 bit ARM processors using a micro-SD by following this guide. You may also include a julia v0.6 tarball, alternatively transferring it using after an installation.If chosing the latter, connect the BB and download the julia tarball for ARM (ARMv7 32-bit hard float) from here and scp it to /home/debian/ on the BB. Run`cd ~/Downloads'\n`scp -r julia-0.6.0-linux-arm.tar.gz debian@192.168.7.2:/home/debian'next, log on to the BB running`ssh debian@192.168.7.2'an unpack the tarball. Julia should now be operational by running`/home/debian/julia-<distro specific tag>/bin/julia'Next, open a new terminal on the HOST and cd to the /util directory of the LabConnection package by running in the julia package folder`cd && cd .julia/v0.6/LabConnection/util'This directory contains some nice utility files to operate the BB from the host. To flash it with the current revision of the software, including all dependencies, simply type`./flash_BB.sh'"
"text": "On the BeagleBone, first install Debian for 32 bit ARM processors using a micro-SD by following this guide. You may also include a julia v0.6 tarball, alternatively transferring it using after an installation.If chosing the latter, connect the BB and download the julia tarball for ARM (ARMv7 32-bit hard float) from here and scp it to /home/debian/ on the BB. Run`cd ~/Downloads'\n`scp -r julia-0.6.0-linux-arm.tar.gz debian@192.168.7.2:/home/debian'next, log on to the BB via SSH by running`ssh debian@192.168.7.2'an unpack the tarball. Julia should now be operational by running`/home/debian/julia-<distro specific tag>/bin/julia'Next, open a new terminal on the HOST and cd to the /util directory of the LabConnection package by running in the julia package folder`cd && cd .julia/v0.6/LabConnection/util'This directory contains some nice utility files to operate the BB from the host. To flash it with the current revision of the software, including all dependencies, simply execut the shells cript `flash.sh'.(Image: block diagram)"
},
{
......@@ -53,7 +53,7 @@ var documenterSearchIndex = {"docs": [
"page": "Installation Instructions",
"title": "Setting up automatic communication between the BB and the HOST via TCP",
"category": "section",
"text": "To setup automatic start of julia server on the beagle boneMake sure that julia is installed in /home/debian/julia-903644385b/bin/julia on the BeagleBone or edit juliaserver.service accordingly\nCreate the folder /home/debian/juliapackages/ on the BeagleBone\nOn the computer, go to LabConnections/util and run ./copyfoldertobb.sh\nIf this failes, make sure that there is not already a folder /home/debian/juliapackages/LabConnections\nCopy LabConnections/src/BeagleBone/startup/juliaserver.service to /lib/systemd/system/juliaserver.service on the BeagleBone.\nRun: sudo systemctl enable juliaserver on BeagleBone\nRun: sudo systemctl start juliaserver on BeagleBoneAfter a while, the BeagleBone should start blinking on SysLED 2: on-off-on-sleep-repeatThe server should now start automatically on restart of the BeagleBone."
"text": "To setup automatic start of Julia server on the BB, make sure to have completed all prior installation instructions. SSH to the BeagleBone and copy the julilaserver.service to the systemd/system`ssh debian@192.168.7.2'\n`sudo cp -r /home/debian/juliapackets/LabConnections/src/BeagleBone/startup/juliaserver.service /lib/systemd/system/juliaserver.service` (on the BeagleBone)Then execute the commandssudo systemctl enable juliaserver (on the BeagleBone) sudo systemctl start juliaserver (on the BeagleBone)After a while, the BeagleBone should start blinking on SysLED 2: on-off-on-sleep-repeat. The server should now start automatically on restart of the BeagleBone, and you should be able to run the examples in in /Examples on the host computer."
},
{
......
This diff is collapsed.
......@@ -18,7 +18,7 @@ If chosing the latter, connect the BB and download the julia tarball for ARM (AR
`cd ~/Downloads'
`scp -r julia-0.6.0-linux-arm.tar.gz debian@192.168.7.2:/home/debian'
next, log on to the BB running
next, log on to the BB via SSH by running
`ssh debian@192.168.7.2'
......@@ -32,20 +32,20 @@ Next, open a new terminal on the HOST and cd to the /util directory of the LabCo
This directory contains some nice utility files to operate the BB from the host. To flash it with the current revision of the software, including all dependencies, simply execut the shells cript `flash.sh'.
![block diagram](flashBB.png)
## Setting up automatic communication between the BB and the HOST via TCP
To setup automatic start of julia server on the beagle bone
1. Make sure that julia is installed in `/home/debian/julia-903644385b/bin/julia` on the BeagleBone or edit `juliaserver.service` accordingly
2. Create the folder `/home/debian/juliapackages/` on the BeagleBone
3. On the computer, go to `LabConnections/util` and run `./copyfoldertobb.sh`
- If this failes, make sure that there is not already a folder `/home/debian/juliapackages/LabConnections`
1. Copy `LabConnections/src/BeagleBone/startup/juliaserver.service` to `/lib/systemd/system/juliaserver.service` on the BeagleBone.
2. Run: `sudo systemctl enable juliaserver` on BeagleBone
3. Run: `sudo systemctl start juliaserver` on BeagleBone
To setup automatic start of Julia server on the BB, make sure to have completed all prior installation instructions. SSH to the BeagleBone and copy the julilaserver.service to the systemd/system
`ssh debian@192.168.7.2'
`sudo cp -r /home/debian/juliapackets/LabConnections/src/BeagleBone/startup/juliaserver.service /lib/systemd/system/juliaserver.service` (on the BeagleBone)
After a while, the BeagleBone should start blinking on SysLED 2: on-off-on-sleep-repeat
Then execute the commands
The server should now start automatically on restart of the BeagleBone.
`sudo systemctl enable juliaserver` (on the BeagleBone)
`sudo systemctl start juliaserver` (on the BeagleBone)
After a while, the BeagleBone should start blinking on SysLED 2: on-off-on-sleep-repeat. The server should now start automatically on restart of the BeagleBone, and you should be able to run the examples in in /Examples on the host computer.
```@systemConfiguration
```
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment