diff --git a/docs/build/lib/functions.md b/docs/build/lib/functions.md index 873f4860e37d2584ef13d321fd815253f4c39b81..733b6bbe88094d27d35f2fefd3899eb4b6c2bf76 100644 --- a/docs/build/lib/functions.md +++ b/docs/build/lib/functions.md @@ -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`** — *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`** — *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`** — *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`** — *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`** — *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`** — *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`** — *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!`** — *Function*. diff --git a/docs/build/lib/io_devices.md b/docs/build/lib/io_devices.md index e43120c99fc49daea6d4e4d8e1bee88b62cd3a87..8ca539c652e34b64bfd40f2f9cec21ad072087f3 100644 --- a/docs/build/lib/io_devices.md +++ b/docs/build/lib/io_devices.md @@ -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]. diff --git a/src/BeagleBone/Debug.jl b/src/BeagleBone/Debug.jl index 9c3b0337cde30719fddf6674a4835afe9a8d8a8c..181a23b68bdf4c9e7ace6783bfc0a2ea9c374179 100644 --- a/src/BeagleBone/Debug.jl +++ b/src/BeagleBone/Debug.jl @@ -1,5 +1,5 @@ """ - Debug() + Debug(i::Int32) Type for debugging and precompile """ type Debug <: IO_Object diff --git a/src/BeagleBone/GPIO.jl b/src/BeagleBone/GPIO.jl index 52e36abca4c55e9e6c347b03a10687755fe0c4f6..09a872a1bc07fa966386a3a607c82667781721a7 100644 --- a/src/BeagleBone/GPIO.jl +++ b/src/BeagleBone/GPIO.jl @@ -1,5 +1,5 @@ """ - 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 diff --git a/src/BeagleBone/PWM.jl b/src/BeagleBone/PWM.jl index 395fcb04dc017d6819a5c1d914a054499405f908..a6b4d202d331a0e9079dec19cb1f5103c2504ac8 100644 --- a/src/BeagleBone/PWM.jl +++ b/src/BeagleBone/PWM.jl @@ -1,5 +1,5 @@ """ - 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. diff --git a/src/BeagleBone/SysLED.jl b/src/BeagleBone/SysLED.jl index f18c85004c963f9605bb2564ec1a47f756105421..42ce55ae58eb1c8e621ae0d1ed02079118a8da02 100644 --- a/src/BeagleBone/SysLED.jl +++ b/src/BeagleBone/SysLED.jl @@ -1,5 +1,5 @@ """ - SysLED + SysLED(i::Int32) Type representing the system LEDs on the BeagleBone. The LEDs are indexed by i ∈ [1,2,3,4]. """