Add docs

Author: aviks

docs/.DS_Store

@@ -0,0 +1,2 @@
+build/
+site/

docs/.gitignore

@@ -0,0 +1,2 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

docs/Project.toml

@@ -0,0 +1,19 @@
+using Documenter
+using SenseHat
+
+makedocs(
+    sitename = "SenseHat",
+    format = Documenter.HTML(),
+    modules = [SenseHat],
+    pages = [
+        "index.md",
+        "API Docs" => "api.md"
+    ]
+)
+
+# Documenter can also automatically deploy documentation to gh-pages.
+# See "Hosting Documentation" and deploydocs() in the Documenter manual
+# for more information.
+#=deploydocs(
+    repo = "<repository url>"
+)=#

docs/make.jl

@@ -0,0 +1,8 @@
+# SenseHat API
+
+```@index
+```
+
+```@autodocs
+Modules = [SenseHat, SenseHat.Stick, SenseHat.LED, SenseHat.Sensors, SenseHat.Text]
+```

docs/src/api.md

@@ -0,0 +1,58 @@
+# SenseHat.jl
+
+SenseHat.jl is a Julia library for interacting with the Raspberry Pi [Sense HAT](https://www.raspberrypi.org/products/sense-hat/).
+
+SenseHat.jl requires the Raspbian `sense-hat` package:
+
+```bash
+sudo apt-get update
+sudo apt-get install sense-hat
+sudo reboot
+```
+
+## LED matrix
+
+The main interface is the `led_matrix()` function, which creates an 8×8 array of RGB
+values (from [ColorTypes.jl](https://github.com/JuliaGraphics/ColorTypes.jl)) which is
+memory-mapped to the frame buffer of the LED matrix. `led_clear()` is a convenience
+function for resetting the LED matrix to black.
+
+```julia
+using SenseHat
+using ColorTypes
+
+const LED = led_matrix()
+
+LED[:] = SenseHat.JULIA_LOGO
+sleep(3)
+led_clear()
+```
+
+## Joystick
+
+In the `Stick` module there is `readstick()` which will block until the joystick is
+manipulated, returning a `StickEvent`:
+
+```julia
+using SenseHat
+
+e = readstick()
+```
+
+For querying within a loop, use a `Channel` to create a buffer of `StickEvent`.
+
+```julia
+using SenseHat
+
+c = Channel{StickEvent}(32)
+
+@async while true
+    put!(c, readstick())
+end
+```
+
+## Sensors
+
+`humidity()`, `temperature()` and `pressure()` will read values from the corresponding sensors.
+
+The inertial measurement unit (IMU) is not yet supported, but is coming soon. In the meantime, you can use the [python library](https://pythonhosted.org/sense-hat/) via [PyCall.jl](https://github.com/JuliaPy/PyCall.jl).

docs/src/index.md

@@ -17,15 +17,18 @@ function _led_fb_device()
             end
         end
     catch e
+        @warn("LED: Sense Hat not found.")
+        return nothing
     end
-    error("Sense Hat device not found.")
 end
 
 const LED_FB_DEVICE_PATH = _led_fb_device()
 const LED_FB_DEVICE = Ref{IOStream}()
 
 function __init__()
-    LED_FB_DEVICE[] = open(LED_FB_DEVICE_PATH,"w+")
+    if LED_FB_DEVICE_PATH != nothing
+        LED_FB_DEVICE[] = open(LED_FB_DEVICE_PATH,"w+")
+    end
 end
 
 const U5 = Normed{UInt8,5}

src/led.jl

@@ -7,8 +7,12 @@ const I2C_DEVICE = Ref{IOStream}()
 const I2C_ADDR = Ref{UInt8}(0xff)
 
 function __init__()
-    I2C_DEVICE[] = open("/dev/i2c-1","r+")
-    HTS221_calibrate()
+    try
+        I2C_DEVICE[] = open("/dev/i2c-1","r+")
+        HTS221_calibrate()
+    catch
+        @warn("I2C: Sense Hat not found")
+    end
 end
 
 import ..ioctl

src/sensors.jl

@@ -15,8 +15,10 @@ function _stick_input_device()
             end
         end
     catch e
+        @warn("STICK: Sense Hat not found.")
+        return nothing
     end
-    error("Sense Hat not found.")
+
 end
 
 const STICK_INPUT_DEVICE = _stick_input_device()