changed livebooks to use published version 0.2

a-maze-d · a-maze-d · commit 9af22d8ab2b5 · 2023-11-12T23:14:15.000+01:00
Updated TODOs with rough version plans
Annotating flaky tests with TODOs
diff --git a/TODO.md b/TODO.md
@@ -1,27 +1,34 @@
 # Intro
 Even though this library is published, there are things I still want to do before I consider this
 as really done. Here the outstanding tasks that I can think of.
+
 # Tasks
-- [ ] Add installation instructions
-- [x] Provide several notebook examples (test env, prod)
-  - [ ] This requires still some minor modifications once the next version is published to not load the code from my local drive (v0.3)
-- [ ] Perform an extra round of testing on hardware (v0.3) 
-- [ ] Enable Telemetry? (v0.5)
-- [ ] Connect everything into a supervision tree (to make it more robust) (v0.4)
-- [ ] Get the library into nerves-livebook (v0.7)
-- [ ] Add proper API/module documentation (v0.3)
-- [ ] Add documentation on how to connect the LED strip to a RaspberryPi Zero (with and without level shifter).
-      This could be part of the first example (v0.3)
-- [ ] Finish the dsl livebook example (mostly done, but the send_config part is not done yet) (v0.2)
+- [ ] Documentation
+  - [x] Provide several notebook examples (v0.2)
+  - [ ] Finish the dsl livebook example (mostly done, but the send_config part is not done yet) (v0.2)
+  - [ ] Add proper API/module documentation (v0.3)
+  - [ ] Add type specs (v0.3)
+  - [ ] Add documentation on how to connect the LED strip to a RaspberryPi Zero (with and without level shifter).This could be part of the first example (v0.3 & v0.4)
+  - [ ] Add installation instructions (v0.4)
 - [ ] Create a dsl (domain specific language) to (finally) easily program strips
   - [x] Define an led strip (v0.2)
   - [x] Define a live_loop (v0.2)
   - [x] Add more macro tests (v0.2)
   - [ ] Extend the Fledex macros to allow easy configuration with a config macro (v0.3)
-- [ ] Add an example where several nodes are connected to transfer pubsub messages accross nodes (v0.3)
-- [x] Change the `Leds`' `new` function to an `leds` function. That makes it more natural to read if the Leds module gets imported. (v0.2)
-- [ ] Remove unnecessary imports in the examples (v0.3)
-- [ ] Add type specs (v0.3)
-- [ ] Add more unit tests, check --cover (v0.3)
-- [ ] Create foundation for a led-component-library that enables defining reusable led components. For example both the clock as well as the weather example have a scale it would be easy to define those as components that would make it easier to defining certain aspects (v0.5)
-- [ ] Upgrade to a final version of circuit_spi v2.0 (whenever available)
+- [ ] Clustering
+  - [ ] Add an example where several nodes are connected to transfer pubsub messages accross nodes (v0.3)
+  - [ ] Create a driver that outputs through pubsub (on one node) and an animation that consumes those (this allows to connect remote livebooks to a physical led strip) 
+- [ ] Cleanup
+  - [x] Change the `Leds`' `new` function to an `leds` function. That makes it more natural to read if the Leds module gets imported. (v0.2)
+  - [x] Remove unnecessary imports in the examples (v0.2)
+  - [x] Add more unit tests, check mix coveralls.html (v0.2)
+  - [ ] Fix flaxy tests (see TODOs) (v0.3)
+  - [ ] Perform an extra round of testing on hardware (v0.3)
+  - [ ] Connect everything into a supervision tree (to make it more robust) (v0.4)
+  - [ ] Enable Telemetry? (v0.5)
+  - [ ] Upgrade to a final version of circuit_spi v2.0 (whenever available) (v0.?)
+- [ ] LED-component library
+  - [ ] Create foundation for a led-component-library that enables defining reusable led components. For example both the clock as well as the weather example have a scale it would be easy to define those as components that would make it easier to defining certain aspects (v0.5)
+- [ ] Increase consumption
+  - [ ] Use in school project (v0.4)
+  - [ ] Get the library into nerves-livebook (v0.7)
diff --git a/livebooks/2_fledex_first_steps.livemd b/livebooks/2_fledex_first_steps.livemd
@@ -5,9 +5,7 @@
 # the libraries will be loaded, but on a nerves_livebook you can only use
 # what has been compiled in.
 Mix.install([
-  {:fledex, "~>0.1"},
-  {:circuits_spi, "~> 2.0-pre.0"},
-  {:kino, "~>0.11"}
+  {:fledex, "~>0.2"},
 ])
 
 # we define a couple of aliases to not have to type that much
diff --git a/livebooks/3_fledex_animations.livemd b/livebooks/3_fledex_animations.livemd
@@ -5,8 +5,7 @@
 # hardware but on a normal livebook, This makes it easier to stay up-to-date and experiment
 # We start to define our fledex library, directly linking to the latest version on github
 Mix.install([
-  {:fledex, path: "/home/maze/Documents/code/fledex"},
-  {:kino, "~>0.11"}
+  {:fledex, "~>0.2"}
 ])
 
 # we define a couple of aliases to not have to type that much
diff --git a/livebooks/4_fledex_clock_example.livemd b/livebooks/4_fledex_clock_example.livemd
@@ -2,8 +2,7 @@
 
 ```elixir
 Mix.install([
-  {:fledex, path: "/home/maze/Documents/code/fledex"},
-  {:kino, "~>0.11"}
+  {:fledex, "~>0.2"}
 ])
 
 # we define a couple of aliases to not have to type that much
diff --git a/livebooks/5_fledex_weather_example.livemd b/livebooks/5_fledex_weather_example.livemd
@@ -2,9 +2,8 @@
 
 ```elixir
 Mix.install([
-  {:fledex, path: "/home/maze/Documents/code/fledex"},
+  {:fledex, "~>0.2"},
   {:json, "~>1.4"},
-  {:kino, "~>0.11"}
 ])
 
 # we define a couple of aliases to not have to type that much
diff --git a/livebooks/6_fledex_dsl.livemd b/livebooks/6_fledex_dsl.livemd
@@ -5,7 +5,7 @@
 # hardware but on a normal livebook, This makes it easier to stay up-to-date and experiment
 # We start to define our fledex library, directly linking to the latest version on github
 Mix.install([
-  {:fledex, path: "/home/maze/Documents/code/fledex"}
+  {:fledex, "~>0.2"}
 ])
 ```
 
diff --git a/test/color_test.exs b/test/color_test.exs
@@ -1,7 +1,6 @@
 defmodule Fledex.ColorTest do
   use ExUnit.Case, async: true
 
-  alias Fledex.Color.Utils
   alias Fledex.Color.Conversion.Approximate
   alias Fledex.Color.Conversion.Rainbow
   alias Fledex.Color.Conversion.Raw
@@ -13,6 +12,7 @@ defmodule Fledex.ColorTest do
 
   alias Fledex.Color.LoadUtils
   alias Fledex.Color.Names
+  alias Fledex.Color.Utils
 
   describe "color correction tests" do
     test "no_color_correction" do
diff --git a/test/fledex_test.exs b/test/fledex_test.exs
@@ -33,6 +33,7 @@ defmodule Fledex.Test do
 
     end
 
+    # TODO: check this test, it seems to be flaky
     test "simple led strip macro" do
       # ensure our servers are not started
       assert GenServer.whereis(@server_name) == nil
diff --git a/test/led_animation_manager_test.exs b/test/led_animation_manager_test.exs
@@ -45,6 +45,7 @@ defmodule Fledex.LedAnimationManagerTest do
       {:ok, state} = LedAnimationManager.get_info()
       assert Map.keys(state) == [strip_name, :strip_name2]
     end
+    # TODO: check this test it seems to be flaky
     test "re-register led_strip", %{strip_name: strip_name} do
       pid = GenServer.whereis(strip_name)
       assert pid != nil
