Merge remote-tracking branch 'openbci/master'

Author: Andrey1994

README.md

@@ -44,6 +44,7 @@ We support bindings for:
 * [C++](./cpp-package/)
 * [C# (Windows only)](./csharp-package/brainflow/)
 * [Matlab](./matlab-package/brainflow)
+* [Julia](.julia-package/brainflow)
 
 ## License: 
 MIT

docs/BuildBrainFlow.rst

@@ -69,6 +69,30 @@ Steps to setup Matlab binding for BrainFlow:
 - Add folders lib and inc to Matlab path
 - If you want to run Matlab scripts from folders different than brainflow/matlab-package/brainflow you need to add it to your Matlab path too
 
+
+Julia
+--------
+
+Steps to setup Julia binding for BrainFlow:
+
+- Compile Core Module, using instructions below
+- Set PATH(on Windows) or LD_LIBRARY_PATH(on Unix) env variables to ensure that compiled libraries are in search path
+- Install BrainFlow package locally
+
+.. compound::
+
+    Example ::
+
+        # compile core module first
+        # set env variable
+        export LD_LIBRARY_PATH=/home/andreyparfenov/brainflow/installed_linux/lib/:$LD_LIBRARY_PATH
+        cd julia-package/brainflow
+        julia
+        # type ']' to switch to pkg terminal
+        activate . # activate BrainFlow's env
+        
+
+
 Compilation of Core Module and C++ Binding
 -------------------------------------------
 

docs/Examples.rst

@@ -269,6 +269,40 @@ Matlab Denoising
 .. literalinclude:: ../matlab-package/brainflow/examples/Denoising.m
    :language: matlab
 
+Julia
+--------
+
+Julia Get Data from a Board
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. literalinclude:: ../julia-package/brainflow/test/brainflow_get_data.jl
+   :language: julia
+
+Julia Read Write File
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. literalinclude:: ../julia-package/brainflow/test/serialization.jl
+   :language: julia
+
+Julia Transforms
+~~~~~~~~~~~~~~~~~~
+
+.. literalinclude:: ../julia-package/brainflow/test/transforms.jl
+   :language: julia
+
+Julia Signal Filtering
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. literalinclude:: ../julia-package/brainflow/test/signal_filtering.jl
+   :language: julia
+
+Julia Denoising
+~~~~~~~~~~~~~~~~~
+
+.. literalinclude:: ../julia-package/brainflow/test/denoising.jl
+   :language: julia
+
+
 Notebooks
 ------------
 .. toctree::

docs/SupportedBoards.rst

@@ -13,9 +13,9 @@ To create an instance of BoardShim class for your board check required inputs in
    "Cyton", "BoardIds.CYTON_BOARD (0)", "dongle serial port(COM3, /dev/ttyUSB0, /dev/cu.usbserial-xxxxxx...)", "-", "-", "-", "-", "-", "-"
    "Ganglion", "BoardIds.GANGLION_BOARD (1)", "dongle serial port(COM3, /dev/ttyUSB0...)", "Optional: Ganglion's MAC address", "-", "-", "-", "-", "Timeout for device discovery(default 15sec)"
    "Cyton Daisy", "BoardIds.CYTON_DAISY_BOARD (2)", "dongle serial port(COM3, /dev/ttyUSB0, /dev/cu.usbserial-xxxxxx...)", "-", "-", "-", "-", "-", "-"
-   "Ganglion Wifi", "BoardIds.GANGLION_WIFI_BOARD (4)", "-", "-", "Wifi Shield IP(default 192.168.4.1)", "any local port which is free", "-", "-", "-"
-   "Cyton Wifi", "BoardIds.CYTON_WIFI_BOARD (5)", "-", "-", "Wifi Shield IP(default 192.168.4.1)", "any local port which is free", "-", "-", "-"
-   "Cyton Daisy Wifi", "BoardIds.CYTON_DAISY_WIFI_BOARD (6)", "-", "-", "Wifi Shield IP(default 192.168.4.1)", "any local port which is free", "-", "-", "-"
+   "Ganglion Wifi", "BoardIds.GANGLION_WIFI_BOARD (4)", "-", "-", "Wifi Shield IP(default 192.168.4.1)", "any local port which is free", "-", "-", "Timeout for HTTP response(default 10sec)"
+   "Cyton Wifi", "BoardIds.CYTON_WIFI_BOARD (5)", "-", "-", "Wifi Shield IP(default 192.168.4.1)", "any local port which is free", "-", "-", "Timeout for HTTP response(default 10sec)"
+   "Cyton Daisy Wifi", "BoardIds.CYTON_DAISY_WIFI_BOARD (6)", "-", "-", "Wifi Shield IP(default 192.168.4.1)", "any local port which is free", "-", "-", "Timeout for HTTP response(default 10sec)"
    "BrainBit", "BoardIds.BRAINBIT_BOARD (7)", "-", "-", "-", "-", "-", "Serial Number of BrainBit device", "Timeout for device discovery(default 15sec)"
 
 
@@ -205,6 +205,7 @@ To choose this board in BoardShim constructor please specify:
 - board_id: 4
 - ip_address field of BrainFlowInputParams structure should contain WiFi Shield Ip address(in direct mode its 192.168.4.1)
 - ip_port field of BrainFlowInputParams structure should be any local port which is free right now
+- optional: timeout field of BrainFlowInputParams structure, default is 10sec
 
 Supported platforms:
 
@@ -235,6 +236,7 @@ To choose this board in BoardShim constructor please specify:
 - board_id: 5
 - ip_address field of BrainFlowInputParams structure should contain WiFi Shield Ip address(in direct mode its 192.168.4.1)
 - ip_port field of BrainFlowInputParams structure should be any local port which is free right now
+- optional: timeout field of BrainFlowInputParams structure, default is 10sec
 
 Supported platforms:
 
@@ -267,6 +269,7 @@ To choose this board in BoardShim constructor please specify:
 - board_id: 6
 - ip_address field of BrainFlowInputParams structure should contain WiFi Shield Ip address(in direct mode its 192.168.4.1)
 - ip_port field of BrainFlowInputParams structure should be any local port which is free right now
+- optional: timeout field of BrainFlowInputParams structure, default is 10sec
 
 Supported platforms:
 

docs/UserAPI.rst

@@ -117,10 +117,27 @@ Full code for R binding:
 Matlab API Reference
 ----------------------
 
-Matlab binding calls C\C++ code as any other binding, it's not compatible with Octave. Use our code samples as a reference for Matlab API.
+Matlab binding calls C\C++ code as any other binding, it's not compatible with Octave. Use Matlab examples and API reference for other languaes as a starting point.
 
 A few general rules to keep in mind:
 
 - Use char arrays instead strings to work with BrainFlow API, it means 'my_string' instead "my_string", otherwise you will get calllib error
 - Use int32 values intead enums, it means int32 (BoardIDs.SYNTHETIC_BOARD) instead BoardIDs.SYNTHETIC_BOARD, the same is true for all enums in BrainFlow API
 
+Like here:
+
+.. literalinclude:: ../matlab-package/brainflow/examples/Serialization.m
+   :language: matlab
+
+
+Julia API Reference
+---------------------
+
+Julia binding calls C\C++ code as any other binding. Use Julia examples and API reference for other languaes as a starting point.
+
+Since Julia is not Object-Oriented language, there is no DataFilter class. BoardShim class exists but all BoardShim class methods were moved to BrainFlow package and you need to pass BoardShim object to them.
+
+Like here:
+
+.. literalinclude:: ../julia-package/brainflow/test/serialization.jl
+   :language: julia

julia-package/README.md

@@ -0,0 +1,23 @@
+# BrainFlow
+
+BrainFlow is a library intended to obtain, parse and analyze EEG, EMG, ECG and other kinds of data from biosensors.
+
+#### Advantages of BrainFlow:
+
+* powerful API with many features to simplify development
+    * Straightforward API for data acquisition
+    * Powerful API for signal filtering, denoising, downsampling...
+    * Development tools like Synthetic board, Streaming board, logging API
+* easy to use
+    * BrainFlow has many bindings, you can choose programming language you like
+    * All programming languages provide the same API, so it's simple to switch
+    * API is uniform for all boards, it makes applications on top of BrainFlow almost board agnostic
+* easy to support and extend
+    * Code to read data and to perform signal processing is implemented only once in C/C++, bindings just call C/C++ methods
+    * Powerful CI/CD system which runs integrations tests for each commit automatically using BrainFlow's Emulator
+    * Simplified process to add new boards and methods
+
+## [BrainFlow Docs, Dev and User guides and other information](https://brainflow.readthedocs.io)
+
+## [BrainFlow's slack workspace](https://openbraintalk.slack.com/), use this [link to join](https://c6ber255cc.execute-api.eu-west-1.amazonaws.com/Express/)
+

julia-package/brainflow/Manifest.toml

@@ -0,0 +1,59 @@
+# This file is machine-generated - editing it directly is not advised
+
+[[Base64]]
+uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
+
+[[Dates]]
+deps = ["Printf"]
+uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
+
+[[Distributed]]
+deps = ["Random", "Serialization", "Sockets"]
+uuid = "8ba89e20-285c-5b6f-9357-94700520ee1b"
+
+[[InteractiveUtils]]
+deps = ["Markdown"]
+uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
+
+[[JSON]]
+deps = ["Dates", "Mmap", "Parsers", "Unicode"]
+git-tree-sha1 = "b34d7cef7b337321e97d22242c3c2b91f476748e"
+uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
+version = "0.21.0"
+
+[[Logging]]
+uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
+
+[[Markdown]]
+deps = ["Base64"]
+uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
+
+[[Mmap]]
+uuid = "a63ad114-7e13-5084-954f-fe012c677804"
+
+[[Parsers]]
+deps = ["Dates", "Test"]
+git-tree-sha1 = "d6d82d5bdbb75048e574cd2d2c89dfbf2c74250c"
+uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
+version = "1.0.0"
+
+[[Printf]]
+deps = ["Unicode"]
+uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"
+
+[[Random]]
+deps = ["Serialization"]
+uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+
+[[Serialization]]
+uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
+
+[[Sockets]]
+uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
+
+[[Test]]
+deps = ["Distributed", "InteractiveUtils", "Logging", "Random"]
+uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[[Unicode]]
+uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"

julia-package/brainflow/Project.toml

@@ -0,0 +1,7 @@
+name = "brainflow"
+uuid = "abd5acf9-0fc9-4730-984d-e27a37823580"
+authors = ["Andrey1994 <a1994ndrey@gmail.com>"]
+version = "0.1.0"
+
+[deps]
+JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"