diff --git a/docs/build/index.md b/docs/build/index.md index ddd957b0faf8eb3551cac6b4e046969214f8155d..7a600d2400f08f4982cab32e7c9317edc6082139 100644 --- a/docs/build/index.md +++ b/docs/build/index.md @@ -43,8 +43,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) diff --git a/docs/build/lib/functions.md b/docs/build/lib/functions.md index 7cf7ae807a57f77682efd2438a1e519e3c213a66..6aeca82ff4a62259dd08b8358b6c8486dc716ae0 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) @@ -44,25 +44,25 @@ Run a server on `port` that listens for commands from computer Optional debug ke -``` -l = read(led::SysLED, debug::Bool=false) -``` - -Reads the current brightness value from the LED 'SysLED'. +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='Base.read' href='#Base.read'>#</a> **`Base.read`** — *Function*. -l = read(pwm::PWM, operation::Int32, debug::Bool=false) Reads the current value from an operation on a GPIO. +``` +l = read(led::SysLED, debug::Bool=false) +``` + +Reads the current brightness value from the LED 'SysLED'. <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*. @@ -176,18 +176,18 @@ Prints all the active devices and writes out specifics of a single devices -``` -teardown!(pwd::PWM) -``` - -Closes all open streams on the PWM, and unexports it from the file system +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*. -teardown(gpio::GPIO, debug::Bool=false) Closes all open streams on the GPIO, and unexports it from the file system. +``` +teardown(led::SysLED, debug::Bool=false) +``` + +Closes all open filestreams for the SysLED 'led'. <a id='LabConnections.BeagleBone.teardown' href='#LabConnections.BeagleBone.teardown'>#</a> **`LabConnections.BeagleBone.teardown`** — *Function*. @@ -195,31 +195,31 @@ teardown(gpio::GPIO, debug::Bool=false) Closes all open streams on the GPIO, and ``` -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*. -to_string(pwm::PWM,, 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(gpio::GPIO, 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`** — *Function*. -to_string(led::SysLED, 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.write!' href='#LabConnections.BeagleBone.write!'>#</a> **`LabConnections.BeagleBone.write!`** — *Function*. @@ -227,26 +227,26 @@ 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!`** — *Function*. -``` -write!(pwm::PWM, args::Tuple{Int32,String}, debug::Bool=false) -``` - -Writes an entry to an operation on the PWM, of the form args = (operation, entry). +write!(gpio::GPIO, args::Tuple{Int32,String}, debug::Bool=false) Writes an entry to an operation on a GPIO, of the form args = (operation, entry). <a id='LabConnections.BeagleBone.write!' href='#LabConnections.BeagleBone.write!'>#</a> **`LabConnections.BeagleBone.write!`** — *Function*. -write!(gpio::GPIO, args::Tuple{Int32,String}, debug::Bool=false) Writes an entry to an operation on a GPIO, of the form args = (operation, entry). +``` +write!(led::SysLED, val::Bool, debug::Bool=false) +``` + +Turns the LED 'SysLed' on/off for val = true/false respectively.