First version

timeflux · Jul 13, 2024 · e1bf0ef · e1bf0ef
1 parent 90876c9
commit e1bf0ef
Show file tree

Hide file tree

Showing 17 changed files with 190 additions and 449 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018, Pierre Clisson <pierre@clisson.net>
+Copyright (c) 2024, Pierre Clisson <pierre@clisson.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.rst b/README.rst
@@ -1,8 +1,7 @@
-An example Timeflux plugin
-==========================
+OctaEEG driver for Timeflux
+===========================
 
-This is an example plugin that provides a few simple demonstration nodes. Use it as a template
-to develop your own plugins.
+This plugin provides a driver to connect to the OctaEEG board
 
 Installation
 ------------
@@ -14,4 +13,4 @@ You can then install this plugin in the `timeflux` environment:
 ::
 
     $ conda activate timeflux
-    $ pip install timeflux_example
+    $ pip install git+https://github.com/timeflux/timeflux_octaeeg.git
diff --git a/examples/dynamic.yaml b/examples/dynamic.yaml
diff --git a/examples/dynamic_prefixed.yaml b/examples/dynamic_prefixed.yaml
diff --git a/examples/multi.yaml b/examples/multi.yaml
diff --git a/examples/sine.yaml b/examples/sine.yaml
diff --git a/examples/sinus.yaml b/examples/sinus.yaml
diff --git a/examples/test.yaml b/examples/test.yaml
@@ -1,27 +1,17 @@
 graphs:
-
-  - nodes:
-    - id: node_1
-      module: timeflux.nodes.random
-      class: Random
-      params:
-        columns: 5
-        rows_min: 1
-        rows_max: 10
-        value_min: 0
-        value_max: 5
-        seed: 1
-    - id: node_2
-      module: timeflux_example.nodes.arithmetic
-      class: Add
-      params:
-        value: 1
-    - id: node_3
-      module: timeflux.nodes.debug
-      class: Display
-
+  - id: EEG
+    nodes:
+      - id: EEG
+        module: timeflux_octaeeg.nodes.driver
+        class: OctaEEG
+        params:
+          rate: 1000
+          gain: 1
+          names: [PO7, O1, Oz, O2, PO8, PO3, POz, PO4]
+      - id: Display
+        module: timeflux.nodes.debug
+        class: Display
     edges:
-    - source: node_1
-      target: node_2
-    - source: node_2
-      target: node_3
+      - source: EEG
+        target: Display
+    rate: 1
diff --git a/setup.cfg b/setup.cfg
@@ -1,15 +1,15 @@
 [metadata]
-name = timeflux-example
-description = An example Timeflux plugin
+name = timeflux-octaeeg
+description = Driver for OctaEEG
 long_description = file: README.rst
 author = Pierre Clisson
 author-email = contact@timeflux.io
 license = MIT
 home-page = https://timeflux.io
 project_urls =
-    Documentation = http://doc.timeflux.io/projects/timeflux-example/
-    Source Code = https://github.com/timeflux/timeflux_example
-    Bug Tracker = https://github.com/timeflux/timeflux_example/issues
+    Documentation = http://doc.timeflux.io/projects/timeflux-octaeeg/
+    Source Code = https://github.com/timeflux/timeflux_octaeeg
+    Bug Tracker = https://github.com/timeflux/timeflux_octaeeg/issues
 classifier =
     Development Status :: 4 - Beta
     Environment :: Console
@@ -23,7 +23,8 @@ keywords = timeflux
 [options]
 packages = find:
 install_requires =
-    timeflux>=0.5.3
+    timeflux>=0.17.1
+    websocket_client>=1.8.0
 
 [options.extras_require]
 dev =
@@ -34,9 +35,9 @@ dev =
     docinit
 
 [docinit]
-name = Example plugin
+name = Timeflux OctaEEG
 parent_url = https://doc.timeflux.io
 logo_url = https://github.com/timeflux/timeflux/raw/master/doc/static/img/logo.png
 
 [build_sphinx]
-warning-is-error = 1
+warning-is-error = 1
diff --git a/test/test_arithmetic.py b/test/test_arithmetic.py
diff --git a/timeflux_example/nodes/arithmetic.py b/timeflux_example/nodes/arithmetic.py