diff --git a/docs/build/index.md b/docs/build/index.md index 1f15185b3ed7965ec7f25eb9e0dfe46d00a4c326..9ff9ffcd5e7dd57559cf22888c7e850ea1baef0f 100644 --- a/docs/build/index.md +++ b/docs/build/index.md @@ -6,20 +6,20 @@ -<a id='Examples-1'></a> +<a id='Getting-Started-1'></a> -## Examples +## Getting Started -- [Examples](examples/examples.md#Examples-1) -- [Tests](examples/testing.md#Tests-1) +- [Introduction](man/introduction.md#Introduction-1) +- [Installation instructions](man/installation.md#Installation-instructions-1) -<a id='Guide-1'></a> +<a id='Examples-1'></a> -## Guide +## Examples -- [Introduction](man/introduction.md#Introduction-1) -- [Installation Instructions](man/installation.md#Installation-Instructions-1) +- [Examples](examples/examples.md#Examples-1) +- [Tests](examples/testing.md#Tests-1) <a id='Functions-1'></a> diff --git a/docs/build/man/installation.md b/docs/build/man/installation.md index dfc060ab894872be0f0f21640d1c82225e75ab08..3ba1d5f8650b60859ba3601ad86803c4f37c4034 100644 --- a/docs/build/man/installation.md +++ b/docs/build/man/installation.md @@ -1,16 +1,10 @@ -<a id='Installation-Instructions-1'></a> +<a id='Installation-instructions-1'></a> +# Installation instructions -<a id='Installation-Instructions-1'></a> -# Installation Instructions - - -In these instructions we explain how to set up a working environment on a host computer and a BeagleBone Black. If you already have a prepared micro-SD card for flashing a BeagleBone, then you can safely skip the first section of these instructions. - - -<a id='On-the-BBB-1'></a> +In these instructions we explain how to set up a working environment on a host computer and a BeagleBone Black (BBB). If you already have a prepared micro-SD card for flashing a BBB, then you can safely skip the first section of these instructions. <a id='Preparing-a-micro-SD-card-1'></a> @@ -18,15 +12,21 @@ In these instructions we explain how to set up a working environment on a host c ## Preparing a micro-SD card -First, we will prepare a micro-SD card with an image of Debian and a binary of Julia, which we then can flash onto the BeagleBone. Start by downloading the Debian image [here](http://beagleboard.org/latest-images) (Debian 9.5 2018-10-07 4GB SD IoT) and write the image onto a micro-SD card ([this guide](http://derekmolloy.ie/write-a-new-image-to-the-beaglebone-black/) is helpful). Proceed by downloading the Julia v1.0 binary for 32-bit ARMv7 found [here](https://julialang.org/downloads/). Put the .tar-file of the Julia binary on the micro-SD card containing the Debian image under `/home/debian`, and unzip it. Make sure that the Julia folder has the correct name by typing +First, we will prepare a micro-SD card with an image of Debian and a binary of Julia, which we then can flash onto the BBB. + + +Start by downloading the Debian image [here](http://beagleboard.org/latest-images) (Debian 9.5 2018-10-07 4GB SD IoT) and write the image onto a micro-SD card ([this guide](http://derekmolloy.ie/write-a-new-image-to-the-beaglebone-black/) is helpful). Proceed by downloading the Julia v1.0 binary for 32-bit ARMv7 found [here](https://julialang.org/downloads/). Put the .tar-file of the Julia binary on the micro-SD card containing the Debian image under `/home/debian`, and unzip it. Make sure that the Julia folder has the correct name by typing ``` -`mv /home/debian/julia-<distro specific tag>/bin/julia /home/debian/julia/bin/julia' +mv /home/debian/julia-<distro specific tag>/bin/julia /home/debian/julia/bin/julia' ``` -The file structure on the micro-SD now has the correct structure. The final step is to make sure that the micro-SD will automatically flash the Debian image onto the BeagleBone when booting up. To do this, follow the instructions found [here](https://elinux.org/Beagleboard:BeagleBoneBlack_Debian#Flashing_eMMC). Congratulations, you now have a prepared micro-SD card ready for flashing BeagleBones. +The file structure on the micro-SD now has the correct structure. + + +The final step is to make sure that the micro-SD will automatically flash the Debian image onto the BBB when booting up. To do this, follow the instructions found [here](https://elinux.org/Beagleboard:BeagleBoneBlack_Debian#Flashing_eMMC). Congratulations, you now have a prepared micro-SD card ready for flashing a BBB. <a id='Flashing-the-BeagleBone-1'></a> @@ -34,7 +34,7 @@ The file structure on the micro-SD now has the correct structure. The final step ## Flashing the BeagleBone -Insert a prepared micro-SD card in the slot on the BeagleBone, and press down the boot button S2 (the button closest to the micro-SD slot) and hold it down while you plug in the USB-cable to the BeagleBone. Keep the S2 button held down for a couple of seconds, until the onboard LEDs start to blink. After a short while the onboard LEDs should start to flash in a wave pattern, indicating that the BeagleBone is being flashed. After a while (can vary between 5-45 minutes) the BeagleBone will be turn off automatically, indicating that the flashing is complete. Remove the micro-SD before powering on the BeagleBone again (otherwise it will start to flash the BeagleBone again). +Insert a prepared micro-SD card in the slot on the BBB, and press down the boot button S2 (the button closest to the micro-SD slot) and hold it down while you plug in the USB-cable to the BBB. Keep the S2 button held down for a couple of seconds, until the onboard LEDs start to blink. After a short while the onboard LEDs should start to blink in a wave pattern, indicating that the BBB is being flashed. After a while (can vary between 5-45 minutes) the BBB will be turn off automatically, indicating that the flashing is complete. Remove the micro-SD before powering on the BBB again (otherwise it will start to flash the BBB again). <a id='Trying-out-the-BeagleBone-1'></a> @@ -42,26 +42,23 @@ Insert a prepared micro-SD card in the slot on the BeagleBone, and press down th ## Trying out the BeagleBone -Now your BeagleBone is ready to use. Log on to the BeagleBone via SSH by opening a terminal and typing +Now your BBB should be ready to use. Log on to the BeagleBone via SSH by opening a terminal and typing ``` -`ssh debian@192.168.7.2' +ssh debian@192.168.7.2 ``` -The default password is `temppwd`. You are now logged in to the BeagleBone running Debian. The Julia binary should be located at `/home/debian/julia-/bin/julia`. You can now start a Julia REPL on the BeagleBone by typing +The default password is `temppwd`. You are now logged in to the BBB running Debian. If the micro-SD was prepared correctly, the Julia binary should be located at `/home/debian/julia/bin/julia`. You can now start a Julia REPL on the BBB by typing ``` -`/home/debian/julia-<distro specific tag>/bin/julia' +/home/debian/julia/bin/julia ``` -If this works correctly, then you have a functioning BeagleBone ready for use with the LabConnections.jl package. - - -<a id='On-the-HOST-1'></a> +If the Julia REPL starts up correctly, then you have a functioning BBB ready for use with the LabConnections.jl package. <a id='Setting-up-the-host-computer-1'></a> diff --git a/docs/build/man/introduction.md b/docs/build/man/introduction.md index 6d7027ef1e3ba510996217a5a0058ff93ca89e6d..5ed1fc4e8362935cbda28253892190fea95d1c98 100644 --- a/docs/build/man/introduction.md +++ b/docs/build/man/introduction.md @@ -4,7 +4,11 @@ # Introduction -<a id='Installation-1'></a> +<img src="/images/labio_overview.png" height="150" width="900"> -## Installation + +This project is developing a software package in [Julia](https://julialang.org/) for interfacing with lab processes using either the [BeagleBone Black Rev C](http://beagleboard.org/) (BBB) with custom [IO-board cape](https://gitlab.control.lth.se/labdev/ioboards), or the old IO-boxes in the labs using Comedi. With this package, the user is able to setup a connection between the host computer and the IO-device, and send and receive control signals and measurements from the lab process. + + +To get started, first follow the installation instruction found [here](installation.md). diff --git a/docs/src/index.md b/docs/src/index.md index 6532b2dc8d9fc6915c7b2f62b52416b4609115d5..02d150e2898370e71bf0f9add33f572915dd2775 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -3,24 +3,20 @@ ```@meta CurrentModule = LabConnections ``` - -## Examples +## Getting Started ```@contents -Pages = ["examples/examples.md", "examples/testing.md"] +Pages = ["man/introduction.md", "man/installation.md"] Depth = 1 ``` - -## Guide +## Examples ```@contents -Pages = ["man/introduction.md", "man/installation.md"] +Pages = ["examples/examples.md", "examples/testing.md"] Depth = 1 ``` - ## Functions ```@contents Pages = ["lib/io_devices.md", "lib/functions.md"] ``` - ## Documentation Index ```@index Pages = ["lib/io_devices.md", "lib/functions.md"] diff --git a/docs/src/man/installation.md b/docs/src/man/installation.md index fa8216a029f1d8d39a1a77d3c2f615d7de5510a2..29ccd1467294819aafd4742fb66fe62c76b02f26 100644 --- a/docs/src/man/installation.md +++ b/docs/src/man/installation.md @@ -1,42 +1,35 @@ -<a id='Installation-Instructions-1'></a> - -# Installation Instructions +# Installation instructions In these instructions we explain how to set up a working environment on a host computer and -a BeagleBone Black. If you already have a prepared micro-SD card for flashing a BeagleBone, +a BeagleBone Black (BBB). If you already have a prepared micro-SD card for flashing a BBB, then you can safely skip the first section of these instructions. - -<a id='On-the-BBB-1'></a> - ## Preparing a micro-SD card -First, we will prepare a micro-SD card with an image of Debian and a binary of Julia, which we then can flash onto the BeagleBone. Start by downloading the Debian image [here](http://beagleboard.org/latest-images) (Debian 9.5 2018-10-07 4GB SD IoT) and write the image onto a micro-SD card ([this guide](http://derekmolloy.ie/write-a-new-image-to-the-beaglebone-black/) is helpful). -Proceed by downloading the Julia v1.0 binary for 32-bit ARMv7 found [here](https://julialang.org/downloads/). Put the .tar-file of the Julia binary on the micro-SD card containing the Debian image under `/home/debian`, and unzip it. +First, we will prepare a micro-SD card with an image of Debian and a binary of Julia, which we then can flash onto the BBB. + +Start by downloading the Debian image [here](http://beagleboard.org/latest-images) (Debian 9.5 2018-10-07 4GB SD IoT) and write the image onto a micro-SD card ([this guide](http://derekmolloy.ie/write-a-new-image-to-the-beaglebone-black/) is helpful). +Proceed by downloading the Julia v1.0 binary for 32-bit ARMv7 found [here](https://julialang.org/downloads/). Put the .tar-file of the Julia binary on the micro-SD card containing the Debian image under `/home/debian`, and unzip it. Make sure that the Julia folder has the correct name by typing ``` -`mv /home/debian/julia-<distro specific tag>/bin/julia /home/debian/julia/bin/julia' +mv /home/debian/julia-<distro specific tag>/bin/julia /home/debian/julia/bin/julia' ``` -The file structure on the micro-SD now has the correct structure. The final step is to make sure that the micro-SD will automatically flash the Debian image onto the BeagleBone when booting up. To do this, follow the instructions found [here](https://elinux.org/Beagleboard:BeagleBoneBlack_Debian#Flashing_eMMC). Congratulations, -you now have a prepared micro-SD card ready for flashing BeagleBones. +The file structure on the micro-SD now has the correct structure. + +The final step is to make sure that the micro-SD will automatically flash the Debian image onto the BBB when booting up. To do this, follow the instructions found [here](https://elinux.org/Beagleboard:BeagleBoneBlack_Debian#Flashing_eMMC). Congratulations, you now have a prepared micro-SD card ready for flashing a BBB. ## Flashing the BeagleBone -Insert a prepared micro-SD card in the slot on the BeagleBone, and press down the boot button S2 (the button closest to the micro-SD slot) and hold it down while you plug -in the USB-cable to the BeagleBone. Keep the S2 button held down for a couple of seconds, until the onboard LEDs start to blink. After a short while the onboard LEDs should -start to flash in a wave pattern, indicating that the BeagleBone is being flashed. After a while (can vary between 5-45 minutes) the BeagleBone will be turn off automatically, -indicating that the flashing is complete. Remove the micro-SD before powering on the BeagleBone again (otherwise it will start to flash the BeagleBone again). +Insert a prepared micro-SD card in the slot on the BBB, and press down the boot button S2 (the button closest to the micro-SD slot) and hold it down while you plug in the USB-cable to the BBB. Keep the S2 button held down for a couple of seconds, until the onboard LEDs start to blink. After a short while the onboard LEDs should start to blink in a wave pattern, indicating that the BBB is being flashed. After a while (can vary between 5-45 minutes) the BBB will be turn off automatically, indicating that the flashing is complete. Remove the micro-SD before powering on the BBB again (otherwise it will start to flash the BBB again). ## Trying out the BeagleBone -Now your BeagleBone is ready to use. Log on to the BeagleBone via SSH by opening a terminal and typing +Now your BBB should be ready to use. Log on to the BeagleBone via SSH by opening a terminal and typing ``` -`ssh debian@192.168.7.2' +ssh debian@192.168.7.2 ``` -The default password is `temppwd`. You are now logged in to the BeagleBone running Debian. The Julia binary should be located at `/home/debian/julia-/bin/julia`. -You can now start a Julia REPL on the BeagleBone by typing +The default password is `temppwd`. You are now logged in to the BBB running Debian. If the micro-SD was prepared correctly, the Julia binary should be located at `/home/debian/julia/bin/julia`. +You can now start a Julia REPL on the BBB by typing ``` -`/home/debian/julia-<distro specific tag>/bin/julia' +/home/debian/julia/bin/julia ``` -If this works correctly, then you have a functioning BeagleBone ready for use with the LabConnections.jl package. - -<a id='On-the-HOST-1'></a> +If the Julia REPL starts up correctly, then you have a functioning BBB ready for use with the LabConnections.jl package. ## Setting up the host computer @@ -120,4 +113,3 @@ and run the startup script: ``` include("/home/debian/juliapackages/LabConnections/src/BeagleBone/startup/startup.jl") ``` - diff --git a/docs/src/man/introduction.md b/docs/src/man/introduction.md index c35df1dc5285bdf134cac3d35bf9e004729d936a..3fbddbb3c595236f9b7707c7bf908714b0f8e600 100644 --- a/docs/src/man/introduction.md +++ b/docs/src/man/introduction.md @@ -1,3 +1,11 @@ # Introduction -## Installation +<img src="/images/labio_overview.png" height="150" width="900"> +This project is developing a software package in [Julia](https://julialang.org/) +for interfacing with lab processes using either the [BeagleBone Black Rev C](http://beagleboard.org/) (BBB) +with custom [IO-board cape](https://gitlab.control.lth.se/labdev/ioboards), or the old IO-boxes in the labs using Comedi. +With this package, the user is able to setup a connection between the +host computer and the IO-device, and send and +receive control signals and measurements from the lab process. + +To get started, first follow the installation instruction found [here](installation.md).