Commit a5e65471 authored by Marcus Greiff's avatar Marcus Greiff

Update docs

parent 76fdf14c
Pipeline #604 passed with stage
in 27 seconds
......@@ -55,7 +55,11 @@ 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.
```
l = read(pwm::PWM, 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*.
......@@ -77,7 +81,7 @@ Reads the current brightness value from the LED 'SysLED'.
assert_pwm_write(operation::Int32, entry::String)
```
Assertsion for the PWM input data
Assertsion for the PWM input data.
<a id='LabConnections.BeagleBone.bbparse-Tuple{Any}' href='#LabConnections.BeagleBone.bbparse-Tuple{Any}'>#</a>
**`LabConnections.BeagleBone.bbparse`** &mdash; *Method*.
......@@ -139,7 +143,11 @@ Exports a dummy filesystem for testing the LED implementation
export_gpio(i::Int32, debug::Bool=false) Export the GPIO file system, either for real-time or testing usecases.
```
export_gpio(i::Int32, debug::Bool=false)
```
Export the GPIO file system, either for real-time or testing usecases.
<a id='LabConnections.BeagleBone.getdev-Tuple{String,Int32}' href='#LabConnections.BeagleBone.getdev-Tuple{String,Int32}'>#</a>
**`LabConnections.BeagleBone.getdev`** &mdash; *Method*.
......@@ -191,10 +199,10 @@ Prints all the active devices and writes out specifics of a single devices.
```
teardown(gpio::GPIO, debug::Bool=false)
teardown!(pwd::PWM)
```
Closes all open streams on the GPIO, and unexports it from the file system.
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*.
......@@ -202,10 +210,10 @@ Closes all open streams on the GPIO, and unexports it from the file system.
```
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`** &mdash; *Function*.
......@@ -213,10 +221,10 @@ Closes all open streams on the PWM, and unexports it from the file system
```
teardown(led::SysLED, debug::Bool=false)
teardown(gpio::GPIO, debug::Bool=false)
```
Closes all open filestreams for the SysLED 'led'.
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*.
......@@ -224,7 +232,7 @@ Closes all open filestreams for the SysLED 'led'.
```
to_string(gpio::GPIO, debug::Bool=false)
to_string(pwm::PWM,, debug::Bool=false)
```
Generates a string representation of the GPIO device.
......@@ -234,14 +242,22 @@ Generates a string representation of the GPIO device.
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.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.write!' href='#LabConnections.BeagleBone.write!'>#</a>
**`LabConnections.BeagleBone.write!`** &mdash; *Function*.
......@@ -249,10 +265,10 @@ to_string(led::SysLED, debug::Bool=false) Generates a string representation of t
```
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='LabConnections.BeagleBone.write!' href='#LabConnections.BeagleBone.write!'>#</a>
**`LabConnections.BeagleBone.write!`** &mdash; *Function*.
......@@ -260,10 +276,10 @@ Turns the LED 'SysLed' on/off for val = true/false respectively.
```
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*.
......
......@@ -52,7 +52,7 @@ end
"""
assert_pwm_write(operation::Int32, entry::String)
Assertsion for the PWM input data
Assertsion for the PWM input data.
"""
function assert_pwm_write(operation::Int32, entry::String)
if operation == "1"
......@@ -68,7 +68,7 @@ function assert_pwm_write(operation::Int32, entry::String)
end
"""
l = read(pwm::PWM, operation::Int32, debug::Bool=false)
l = read(pwm::PWM, operation::Int32, debug::Bool=false)
Reads the current value from an operation on a GPIO.
"""
function read(pwm::PWM, operation::Int32, debug::Bool=false)
......@@ -111,7 +111,7 @@ function teardown(pwm::PWM, debug::Bool=false)
end
"""
export_gpio(i::Int32, debug::Bool=false)
export_gpio(i::Int32, debug::Bool=false)
Export the GPIO file system, either for real-time or testing usecases.
"""
function export_pwm(i::Int32)
......@@ -152,7 +152,7 @@ function export_pwm(i::Int32)
end
"""
to_string(pwm::PWM,, debug::Bool=false)
to_string(pwm::PWM,, debug::Bool=false)
Generates a string representation of the GPIO device.
"""
function to_string(pwm::PWM, debug::Bool=false)
......
......@@ -88,7 +88,7 @@ function export_led(i::Int32, debug::Bool=false)
end
"""
to_string(led::SysLED, debug::Bool=false)
to_string(led::SysLED, debug::Bool=false)
Generates a string representation of the GPIO device.
"""
function to_string(led::SysLED, debug::Bool=false)
......
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