Commit 7405f45c authored by Marcus Greiff's avatar Marcus Greiff

Update docs

parent aca78699
Pipeline #601 passed with stage
in 27 seconds
......@@ -51,14 +51,14 @@ Reads the current brightness value from the LED 'SysLED'.
l = read(pwm::PWM, operation::Int32, debug::Bool=false) Reads the current value from an operation on a GPIO.
l = read(gpio::GPIO, operation::Int32, debug::Bool=false) Reads the current value from an operation on a GPIO.
<a id='Base.read' href='#Base.read'>#</a>
**`Base.read`** &mdash; *Function*.
l = read(gpio::GPIO, operation::Int32, debug::Bool=false) Reads the current value from an operation on a GPIO.
l = read(pwm::PWM, operation::Int32, debug::Bool=false) Reads the current value from an operation on a GPIO.
<a id='LabConnections.BeagleBone.assert_pwm_write-Tuple{Int32,String}' href='#LabConnections.BeagleBone.assert_pwm_write-Tuple{Int32,String}'>#</a>
**`LabConnections.BeagleBone.assert_pwm_write`** &mdash; *Method*.
......@@ -152,18 +152,18 @@ message = printdev() Prints all the active devices and writes out specifics of a
teardown(gpio::GPIO, debug::Bool=false) Closes all open streams on the GPIO, and unexports it from the file system.
```
teardown!(pwd::PWM)
```
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*.
```
teardown(led::SysLED, debug::Bool=false)
```
Closes all open filestreams for the SysLED 'led'.
teardown(gpio::GPIO, debug::Bool=false) Closes all open streams on the GPIO, and unexports it from the file system.
<a id='LabConnections.BeagleBone.teardown' href='#LabConnections.BeagleBone.teardown'>#</a>
**`LabConnections.BeagleBone.teardown`** &mdash; *Function*.
......@@ -171,31 +171,31 @@ Closes all open filestreams for the SysLED 'led'.
```
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.to_string' href='#LabConnections.BeagleBone.to_string'>#</a>
**`LabConnections.BeagleBone.to_string`** &mdash; *Function*.
to_string(gpio::GPIO, debug::Bool=false) Generates a string representation of the GPIO device.
to_string(pwm::PWM,, debug::Bool=false) Generates a string representation of the GPIO device.
<a id='LabConnections.BeagleBone.to_string' href='#LabConnections.BeagleBone.to_string'>#</a>
**`LabConnections.BeagleBone.to_string`** &mdash; *Function*.
to_string(led::SysLED, debug::Bool=false) Generates a string representation of the GPIO device.
to_string(gpio::GPIO, debug::Bool=false) Generates a string representation of the GPIO device.
<a id='LabConnections.BeagleBone.to_string' href='#LabConnections.BeagleBone.to_string'>#</a>
**`LabConnections.BeagleBone.to_string`** &mdash; *Function*.
to_string(pwm::PWM,, debug::Bool=false) Generates a string representation of the GPIO device.
to_string(led::SysLED, debug::Bool=false) Generates a string representation of the GPIO device.
<a id='LabConnections.BeagleBone.write!' href='#LabConnections.BeagleBone.write!'>#</a>
**`LabConnections.BeagleBone.write!`** &mdash; *Function*.
......
......@@ -15,7 +15,7 @@
```
Debug()
Debug(i::Int32)
```
Type for debugging and precompile
......@@ -26,7 +26,7 @@ Type for debugging and precompile
```
GPIO()
GPIO(i::Int32)
```
Lowest form of communication with the GPIO pins. The available pins are listed in the "channel" parameter, and appear as directories in /sys/class/gpio after being exported. For instance, to setup a GPIO on "gpio112", configure it as an output pin and set it to high, the following code would be used.
......@@ -56,7 +56,7 @@ Define abstract type for pins/LEDS on the BeagleBone
```
PWM()
PWM(i::Int32)
```
This device allows for low level PWM control of selected pins. The valid pins dictionary pwm_pins relates to memory adresses in of the AM3359 chip, see p.182 in www.ti.com/product/AM3359/technicaldocuments.
......@@ -67,7 +67,7 @@ This device allows for low level PWM control of selected pins. The valid pins di
```
SysLED
SysLED(i::Int32)
```
Type representing the system LEDs on the BeagleBone. The LEDs are indexed by i ∈ [1,2,3,4].
......
"""
Debug()
Debug(i::Int32)
Type for debugging and precompile
"""
type Debug <: IO_Object
......
"""
GPIO()
GPIO(i::Int32)
Lowest form of communication with the GPIO pins. The available pins are
listed in the "channel" parameter, and appear as directories in /sys/class/gpio
after being exported. For instance, to setup a GPIO on "gpio112", configure it as an output pin and set
......
"""
PWM()
PWM(i::Int32)
This device allows for low level PWM control of selected pins. The valid pins
dictionary pwm_pins relates to memory adresses in of the AM3359 chip, see p.182
in www.ti.com/product/AM3359/technicaldocuments.
......
"""
SysLED
SysLED(i::Int32)
Type representing the system LEDs on the BeagleBone. The LEDs are indexed by
i ∈ [1,2,3,4].
"""
......
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