Made a new doc build.

parent eca2c020
Pipeline #632 passed with stage
in 27 seconds
......@@ -45,10 +45,10 @@ Run a server on `port` that listens for commands from computer Optional debug ke
```
l = read(led::SysLED, debug::Bool=false)
l = read(gpio::GPIO, operation::Int32, debug::Bool=false)
```
Reads the current brightness value from the LED 'SysLED'.
Reads the current value from an operation on a GPIO.
<a id='Base.read' href='#Base.read'>#</a>
**`Base.read`** &mdash; *Function*.
......@@ -56,10 +56,10 @@ Reads the current brightness value from the LED 'SysLED'.
```
l = read(pwm::PWM, operation::Int32, debug::Bool=false)
l = read(led::SysLED, debug::Bool=false)
```
Reads the current value from an operation on a GPIO.
Reads the current brightness value from the LED 'SysLED'.
<a id='Base.read' href='#Base.read'>#</a>
**`Base.read`** &mdash; *Function*.
......@@ -67,7 +67,7 @@ Reads the current value from an operation on a GPIO.
```
l = read(gpio::GPIO, operation::Int32, debug::Bool=false)
l = read(pwm::PWM, operation::Int32, debug::Bool=false)
```
Reads the current value from an operation on a GPIO.
......@@ -199,10 +199,10 @@ Prints all the active devices and writes out specifics of a single devices.
```
teardown(gpio::GPIO, debug::Bool=false)
teardown(led::SysLED, debug::Bool=false)
```
Closes all open streams on the GPIO, and unexports it from the file system.
Closes all open filestreams for the SysLED 'led'.
<a id='LabConnections.BeagleBone.teardown' href='#LabConnections.BeagleBone.teardown'>#</a>
**`LabConnections.BeagleBone.teardown`** &mdash; *Function*.
......@@ -210,10 +210,10 @@ Closes all open streams on the GPIO, and unexports it from the file system.
```
teardown(led::SysLED, debug::Bool=false)
teardown!(pwd::PWM)
```
Closes all open filestreams for the SysLED 'led'.
Closes all open streams on the PWM, and unexports it from the file system
<a id='LabConnections.BeagleBone.teardown' href='#LabConnections.BeagleBone.teardown'>#</a>
**`LabConnections.BeagleBone.teardown`** &mdash; *Function*.
......@@ -221,10 +221,10 @@ Closes all open filestreams for the SysLED 'led'.
```
teardown!(pwd::PWM)
teardown(gpio::GPIO, debug::Bool=false)
```
Closes all open streams on the PWM, and unexports it from the file system
Closes all open streams on the GPIO, and unexports it from the file system.
<a id='LabConnections.BeagleBone.to_string' href='#LabConnections.BeagleBone.to_string'>#</a>
**`LabConnections.BeagleBone.to_string`** &mdash; *Function*.
......@@ -232,7 +232,7 @@ Closes all open streams on the PWM, and unexports it from the file system
```
to_string(gpio::GPIO, debug::Bool=false)
to_string(led::SysLED, debug::Bool=false)
```
Generates a string representation of the GPIO device.
......@@ -243,7 +243,7 @@ Generates a string representation of the GPIO device.
```
to_string(led::SysLED, debug::Bool=false)
to_string(pwm::PWM,, debug::Bool=false)
```
Generates a string representation of the GPIO device.
......@@ -254,7 +254,7 @@ Generates a string representation of the GPIO device.
```
to_string(pwm::PWM,, debug::Bool=false)
to_string(gpio::GPIO, debug::Bool=false)
```
Generates a string representation of the GPIO device.
......@@ -276,10 +276,10 @@ Writes an entry to an operation on a GPIO, of the form args = (operation, entry)
```
write!(pwm::PWM, args::Tuple{Int32,String}, debug::Bool=false)
write!(led::SysLED, val::Bool, debug::Bool=false)
```
Writes an entry to an operation on the PWM, of the form args = (operation, entry).
Turns the LED 'SysLed' on/off for val = true/false respectively.
<a id='LabConnections.BeagleBone.write!' href='#LabConnections.BeagleBone.write!'>#</a>
**`LabConnections.BeagleBone.write!`** &mdash; *Function*.
......@@ -287,8 +287,8 @@ Writes an entry to an operation on the PWM, of the form args = (operation, entry
```
write!(led::SysLED, val::Bool, debug::Bool=false)
write!(pwm::PWM, args::Tuple{Int32,String}, debug::Bool=false)
```
Turns the LED 'SysLed' on/off for val = true/false respectively.
Writes an entry to an operation on the PWM, of the form args = (operation, entry).
<a id='Installation-Instructions-1'></a>
# Installation Instructions
......@@ -54,7 +55,7 @@ Once Julia is installed, run
```
in the Julia prompt to install all dependencies on the HOST, the source code is then located in `./julia/v0.6/LabConnections'.
in the Julia prompt to install all dependencies on the HOST, the source code is then located in `./julia/v0.6/LabCOnnections'.
If you plan on working with the SPI devices to debug the ADC/DAC, then you will need a forked `serbus' repository which wraps the`linux/spi/spidev'. Simply
......@@ -78,7 +79,7 @@ To update the BB with the latest revision of the code,
```
This scripts bundles the current code in LabConnections and serbus on the host computer and transfers it to the /home/debian/juliapackages directory on the BB.
This scripts bundles the current code in LabCOnnections and serbus on the host computer and transfers it to the /home/debian/juliapackages directory on the BB.
<a id='Setting-up-automatic-communication-1'></a>
......@@ -91,7 +92,7 @@ To setup automatic start of Julia server on the BB, make sure to have completed
```
`ssh debian@192.168.7.2'
`sudo cp -r /home/debian/juliapackages/LabConnections/src/BeagleBone/startup/juliaserver.service /lib/systemd/system/juliaserver.service` (on the BeagleBone)
`sudo cp -r /home/debian/juliapackets/LabConnections/src/BeagleBone/startup/juliaserver.service /lib/systemd/system/juliaserver.service` (on the BeagleBone)
```
......@@ -108,14 +109,24 @@ After a while, the BeagleBone should start blinking on SysLED 2: on-off-on-sleep
```
<a id='Debugging-1'></a>
## Debugging
No errors will be seen on the BeagleBone when the automatic startup is used. For debugging purposes it might be useful to start the service manually on the beagle bone.
Start julia as root:
No errors will be seen on the BeagleBone when the automatic startup is used. For debugging purposes it might be useful to start the service manually on the beagle bone. Start julia as root:
```
sudo /home/debian/julia/bin/julia
```
and run the startup script:
```
include("/home/debian/juliapackages/LabConnections/src/BeagleBone/startup/startup.jl")
```
\ No newline at end of file
```
<a id='Introduction-1'></a>
# Introduction
......@@ -7,24 +8,3 @@
## Installation
## Future Work
### SPI Development
The SPI development is done in C and in a forked repository, currently
separated from the julia project. If you wish to work on the SPI implementation,
simply clone the repository "serbus", a small C stack available at
`github.com/mgreiff/serbus` into your julia package directory (for example
`~/.julia/v0.6`). Then, in the LabConnections package on the host computer, run
`flash_BB.sh` in the `/utils` directory transferring both LabConnections and
serbus to the BB.
On the BB, run
cp /home/debian/juliapackages/serbus/bb_spi.sh /home/debian
and then execute
./bb_spi.sh
in the `/home/debian` directory to run the SPI example with the ADC from SPI0.
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