From 4222f7d1845add8cc602f8d8875089ca161dcddd Mon Sep 17 00:00:00 2001
From: mgreiff <marcusgreiff.93@hotmail.com>
Date: Tue, 19 Dec 2017 14:09:13 +0100
Subject: [PATCH] Update documentation
---
docs/build/search_index.js | 2 +-
docs/build/testing.html | 2 +-
docs/src/testing.md | 20 ++++++++++++++------
test/testBB.jl | 5 +++++
4 files changed, 21 insertions(+), 8 deletions(-)
diff --git a/docs/build/search_index.js b/docs/build/search_index.js
index 905950b..efd27e2 100644
--- a/docs/build/search_index.js
+++ b/docs/build/search_index.js
@@ -109,7 +109,7 @@ var documenterSearchIndex = {"docs": [
"page": "Tests",
"title": "Tests",
"category": "section",
- "text": "The BeagleBone IO communication can be testedDepth = 3"
+ "text": "The BeagleBone tests can be run on any computer, regrdless of their file-syste. By setting the flag RUNNING_TESTS to true, a dummy file-system is exported in which the tests are run operate. This has the advantage of enabling testing of the code run on the BB free from the BB itself, without building the Debian FS, thereby enabling the automatic testing through Travis.To run the tests, simply enter the /test/ directory and runjulia run_tests.jlIf the tests are to be run on the BB with hardware in the loop, runjulia run_tests.jlon the BB, to run examples separately, see... examples ..."
},
{
diff --git a/docs/build/testing.html b/docs/build/testing.html
index 8429d30..f8dd85d 100644
--- a/docs/build/testing.html
+++ b/docs/build/testing.html
@@ -1,2 +1,2 @@
<!DOCTYPE html>
-<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Tests · 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" id="search-form" action="search.html"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li><a class="toctext" href="index.html">LabConnections</a></li><li><a class="toctext" href="installation.html">Installation Instructions</a></li><li><a class="toctext" href="systemConfiguration.html">System Configuration (deprecated)</a></li><li class="current"><a class="toctext" href="testing.html">Tests</a><ul class="internal"></ul></li><li><a class="toctext" href="examples.html">Examples on the BB</a></li></ul></nav><article id="docs"><header><nav><ul><li><a href="testing.html">Tests</a></li></ul><a class="edit-page" href="https://github.com//blob/master/docs/src/testing.md"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>Tests</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="Tests-1" href="#Tests-1">Tests</a></h1><p>The BeagleBone IO communication can be tested</p><ul><li><a href="examples.html#Examples-on-the-BB-1">Examples on the BB</a></li><ul><li><a href="examples.html#Example-with-LEDs-(BB)-1">Example with LEDs (BB)</a></li><li><a href="examples.html#Example-with-GPIOs-(BB)-1">Example with GPIOs (BB)</a></li><li><a href="examples.html#Example-with-PWM-(BB)-1">Example with PWM (BB)</a></li><li><a href="examples.html#Example-with-SPI-(BB)-1">Example with SPI (BB)</a></li><li><a href="examples.html#Example-with-LEDs-(HOST)-1">Example with LEDs (HOST)</a></li></ul><li><a href="testing.html#Tests-1">Tests</a></li><li><a href="installation.html#Installation-Instructions-1">Installation Instructions</a></li><ul><li><a href="installation.html#On-the-BBB-1">On the BBB</a></li><li><a href="installation.html#On-the-HOST-1">On the HOST</a></li><li><a href="installation.html#Setting-up-automatic-communication-1">Setting up automatic communication</a></li></ul><li><a href="index.html#LabConnections-1">LabConnections</a></li><li><a href="systemConfiguration.html#System-Configuration-(deprecated)-1">System Configuration (deprecated)</a></li><ul><li><a href="systemConfiguration.html#Configuration-interfaces-(deprecated)-1">Configuration interfaces (deprecated)</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="previous" href="systemConfiguration.html"><span class="direction">Previous</span><span class="title">System Configuration (deprecated)</span></a><a class="next" href="examples.html"><span class="direction">Next</span><span class="title">Examples on the BB</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>Tests · 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" id="search-form" action="search.html"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li><a class="toctext" href="index.html">LabConnections</a></li><li><a class="toctext" href="installation.html">Installation Instructions</a></li><li><a class="toctext" href="systemConfiguration.html">System Configuration (deprecated)</a></li><li class="current"><a class="toctext" href="testing.html">Tests</a><ul class="internal"></ul></li><li><a class="toctext" href="examples.html">Examples on the BB</a></li></ul></nav><article id="docs"><header><nav><ul><li><a href="testing.html">Tests</a></li></ul><a class="edit-page" href="https://github.com//blob/master/docs/src/testing.md"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>Tests</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="Tests-1" href="#Tests-1">Tests</a></h1><p>The BeagleBone tests can be run on any computer, regrdless of their file-syste. By setting the flag RUNNING_TESTS to true, a dummy file-system is exported in which the tests are run operate. This has the advantage of enabling testing of the code run on the BB free from the BB itself, without building the Debian FS, thereby enabling the automatic testing through Travis.</p><p>To run the tests, simply enter the /test/ directory and run</p><pre><code class="language-none">julia run_tests.jl</code></pre><p>If the tests are to be run on the BB with hardware in the loop, run</p><pre><code class="language-none">julia run_tests.jl</code></pre><p>on the BB, to run examples separately, see</p><p>... <a href="@ref">examples</a> ...</p><footer><hr/><a class="previous" href="systemConfiguration.html"><span class="direction">Previous</span><span class="title">System Configuration (deprecated)</span></a><a class="next" href="examples.html"><span class="direction">Next</span><span class="title">Examples on the BB</span></a></footer></article></body></html>
diff --git a/docs/src/testing.md b/docs/src/testing.md
index 9fd4633..98cde17 100644
--- a/docs/src/testing.md
+++ b/docs/src/testing.md
@@ -1,8 +1,16 @@
# Tests
-The BeagleBone IO communication can be tested
-```@contents
-Depth = 3
-```
+The BeagleBone tests can be run on any computer, regrdless of their file-syste.
+By setting the flag RUNNING_TESTS to true, a dummy file-system is exported in
+which the tests are run operate. This has the advantage of enabling testing of
+the code run on the BB free from the BB itself, without building the Debian FS,
+thereby enabling the automatic testing through Travis.
-```@systemConfiguration
-```
+To run the tests, simply enter the /test/ directory and run
+
+ julia run_tests.jl
+
+If the tests are to be run on the BB with hardware in the loop, run
+
+ julia run_tests.jl
+
+on the BB, to run examples separately, see
diff --git a/test/testBB.jl b/test/testBB.jl
index 1cc048b..f0499b3 100644
--- a/test/testBB.jl
+++ b/test/testBB.jl
@@ -1,5 +1,10 @@
using LabConnections
using Base.Test
+# This flag is enabled if a dummy filesystem should be used for testing (for online testing)
+# disabling the flag allows the BBB to be run in the loop, in this case blinking LEDS
+RUNNING_TESTS = true
+
+include("BeagleBone/SYS_LED_test.jl")
include("BeagleBone/PWM_test.jl")
include("BeagleBone/GPIO_test.jl")
--
GitLab