diff --git a/docs/build/index.md b/docs/build/index.md index 862628dc48fbf48f742e10b9fa4034c06fa403be..9ff9ffcd5e7dd57559cf22888c7e850ea1baef0f 100644 --- a/docs/build/index.md +++ b/docs/build/index.md @@ -12,7 +12,6 @@ - [Introduction](man/introduction.md#Introduction-1) - [Installation instructions](man/installation.md#Installation-instructions-1) -- [Development](man/development.md#Package-Development-1) <a id='Examples-1'></a> @@ -43,8 +42,8 @@ - [`Base.read`](lib/functions.md#Base.read) - [`Base.read`](lib/functions.md#Base.read) - [`LabConnections.BeagleBone.assert_pwm_write`](lib/functions.md#LabConnections.BeagleBone.assert_pwm_write-Tuple{Int32,String}) -- [`LabConnections.BeagleBone.bbparse`](lib/functions.md#LabConnections.BeagleBone.bbparse-Tuple{Tuple,Any}) - [`LabConnections.BeagleBone.bbparse`](lib/functions.md#LabConnections.BeagleBone.bbparse-Tuple{Any}) +- [`LabConnections.BeagleBone.bbparse`](lib/functions.md#LabConnections.BeagleBone.bbparse-Tuple{Tuple,Any}) - [`LabConnections.BeagleBone.closedev`](lib/functions.md#LabConnections.BeagleBone.closedev-Tuple{String,Int32}) - [`LabConnections.BeagleBone.export_gpio`](lib/functions.md#LabConnections.BeagleBone.export_gpio-Tuple{Int32}) - [`LabConnections.BeagleBone.export_led`](lib/functions.md#LabConnections.BeagleBone.export_led) @@ -63,3 +62,4 @@ - [`LabConnections.BeagleBone.write!`](lib/functions.md#LabConnections.BeagleBone.write!) - [`LabConnections.BeagleBone.write!`](lib/functions.md#LabConnections.BeagleBone.write!) - [`LabConnections.BeagleBone.write!`](lib/functions.md#LabConnections.BeagleBone.write!) + diff --git a/docs/build/lib/functions.md b/docs/build/lib/functions.md index b929ebcaa893bba0ac30bc2a3ef9fe288f8a17e6..23f8f58d82d3a57100e5323ef944bda59e6abcdc 100644 --- a/docs/build/lib/functions.md +++ b/docs/build/lib/functions.md @@ -2,8 +2,8 @@ - [`Base.read`](functions.md#Base.read) - [`Base.read`](functions.md#Base.read) - [`LabConnections.BeagleBone.assert_pwm_write`](functions.md#LabConnections.BeagleBone.assert_pwm_write-Tuple{Int32,String}) -- [`LabConnections.BeagleBone.bbparse`](functions.md#LabConnections.BeagleBone.bbparse-Tuple{Tuple,Any}) - [`LabConnections.BeagleBone.bbparse`](functions.md#LabConnections.BeagleBone.bbparse-Tuple{Any}) +- [`LabConnections.BeagleBone.bbparse`](functions.md#LabConnections.BeagleBone.bbparse-Tuple{Tuple,Any}) - [`LabConnections.BeagleBone.closedev`](functions.md#LabConnections.BeagleBone.closedev-Tuple{String,Int32}) - [`LabConnections.BeagleBone.export_gpio`](functions.md#LabConnections.BeagleBone.export_gpio-Tuple{Int32}) - [`LabConnections.BeagleBone.export_led`](functions.md#LabConnections.BeagleBone.export_led) @@ -45,10 +45,10 @@ Run a server on `port` that listens for commands from computer Optional debug ke ```julia -l = read(led::SysLED, debug::Bool=false) +l = read(pwm::PWM, 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`** — *Function*. @@ -56,10 +56,10 @@ Reads the current brightness value from the LED 'SysLED'. ```julia -l = read(gpio::GPIO, 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`** — *Function*. @@ -67,7 +67,7 @@ Reads the current value from an operation on a GPIO. ```julia -l = read(pwm::PWM, operation::Int32, debug::Bool=false) +l = read(gpio::GPIO, operation::Int32, debug::Bool=false) ``` Reads the current value from an operation on a GPIO. @@ -210,10 +210,10 @@ Closes all open streams on the GPIO, and unexports it from the file system. ```julia -teardown!(pwd::PWM) +teardown(led::SysLED, debug::Bool=false) ``` -Closes all open streams on the PWM, 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`** — *Function*. @@ -221,10 +221,10 @@ Closes all open streams on the PWM, and unexports it from the file system ```julia -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.to_string' href='#LabConnections.BeagleBone.to_string'>#</a> **`LabConnections.BeagleBone.to_string`** — *Function*. @@ -243,7 +243,7 @@ Generates a string representation of the GPIO device. ```julia -to_string(pwm::PWM,, debug::Bool=false) +to_string(led::SysLED, debug::Bool=false) ``` Generates a string representation of the GPIO device. @@ -254,7 +254,7 @@ Generates a string representation of the GPIO device. ```julia -to_string(led::SysLED, debug::Bool=false) +to_string(pwm::PWM,, debug::Bool=false) ``` Generates a string representation of the GPIO device. @@ -276,10 +276,10 @@ Turns the LED 'SysLed' on/off for val = true/false respectively. ```julia -write!(gpio::GPIO, args::Tuple{Int32,String}, debug::Bool=false) +write!(pwm::PWM, args::Tuple{Int32,String}, debug::Bool=false) ``` -Writes an entry to an operation on a GPIO, of the form args = (operation, entry). +Writes an entry to an operation on the PWM, of the form args = (operation, entry). <a id='LabConnections.BeagleBone.write!' href='#LabConnections.BeagleBone.write!'>#</a> **`LabConnections.BeagleBone.write!`** — *Function*. @@ -287,8 +287,8 @@ Writes an entry to an operation on a GPIO, of the form args = (operation, entry) ```julia -write!(pwm::PWM, args::Tuple{Int32,String}, debug::Bool=false) +write!(gpio::GPIO, args::Tuple{Int32,String}, debug::Bool=false) ``` -Writes an entry to an operation on the PWM, of the form args = (operation, entry). +Writes an entry to an operation on a GPIO, of the form args = (operation, entry). diff --git a/docs/build/man/development.md b/docs/build/man/development.md index aec7e6684da4af62d493361d082a4d1a4d74b5f6..256b57aea740684bb10bc4acb2d1fd7c4b5e87b8 100644 --- a/docs/build/man/development.md +++ b/docs/build/man/development.md @@ -28,20 +28,3 @@ git pull to ensure that you are working on the correct development branch for Julia v1.0.X. - -<a id='SPI-Development-1'></a> - -### SPI Development - - -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 - - -``` -`cd && cd .julia/v0.6' -`git clone https://github.com/mgreiff/serbus' -``` - - -to get the latest revision of the serbus fork. - diff --git a/docs/build/man/installation.md b/docs/build/man/installation.md index 21b6b3e3f651a78aa89cb91572f7f746096d076f..9d27023e06889df4efaef503c396fdadc84b91ff 100644 --- a/docs/build/man/installation.md +++ b/docs/build/man/installation.md @@ -28,6 +28,23 @@ To get started, first install Julia v1.0.X on the host computer running a Linux You now have the LabConnections.jl package available on the host computer. Note that for Julia v1.0.X it is the branch `julia1` of the package that should be used. +<a id='Installing-Serbus-1'></a> + +### Installing Serbus + + +To work with the SPI devices you will need a forked `serbus` repository which wraps the`linux/spi/spidev`. Open up a terminal and type + + +``` +cd && cd .julia/packages +git clone https://github.com/mgreiff/serbus +``` + + +to get the latest revision of the `serbus` fork. You are now done with the setup required on the host computer side. + + <a id='BeagleBone-setup-1'></a> ## BeagleBone setup @@ -87,21 +104,22 @@ The default password is `temppwd`. You are now logged in to the BBB running Debi If the Julia REPL starts up correctly, then you have a functioning BBB ready for use with the LabConnections.jl package. -<a id='Getting-LabConnections.jl-on-the-BeagleBone-1'></a> +<a id='Getting-LabConnections.jl-and-serbus-on-the-BeagleBone-1'></a> -### Getting LabConnections.jl on the BeagleBone +### Getting LabConnections.jl and serbus on the BeagleBone -To update the BBB with the latest revision of the code, +To update the BBB with the latest revision of the code, open up a terminal and type ``` -`cd && cd .julia/v0.6/LabConnection/util' -`./flash_BB.sh' +cd +cd .julia/packages/LabConnections/<version id>/util +./flash_BB.sh ``` -This scripts bundles the current code in LabConnections (and serbus, see SPI development below) on the host computer and transfers it to the /home/debian/juliapackages directory on the BBB. +This scripts bundles the current code in LabConnections.jl and serbus on the host computer and transfers it to the BBB and puts it in the directory `/home/debian/juliapackages`. <a id='Setting-up-automatic-communication-1'></a> @@ -116,8 +134,8 @@ 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/juliapackets/LabConnections/src/BeagleBone/startup/juliaserver.service /lib/systemd/system/juliaserver.service` (on the BeagleBone) +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) ``` diff --git a/docs/src/man/installation.md b/docs/src/man/installation.md index 03be1fe573e715b8d92a3445754597ed95245bec..c3b75b9e5bc9059ec65b83f00a8f3411ad516975 100644 --- a/docs/src/man/installation.md +++ b/docs/src/man/installation.md @@ -54,10 +54,11 @@ If the Julia REPL starts up correctly, then you have a functioning BBB ready for To update the BBB with the latest revision of the code, open up a terminal and type ``` -cd && cd .julia/packages/LabConnections/<version id>/util +cd +cd .julia/packages/LabConnections/<version id>/util ./flash_BB.sh ``` -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 BBB. +This scripts bundles the current code in LabConnections.jl and serbus on the host computer and transfers it to the BBB and puts it in the directory `/home/debian/juliapackages`. <a id='Setting-up-automatic-communication-1'></a>