Difference between revisions of "Documentation/Nightly/Extensions/ArduinoController"

From Slicer Wiki
Jump to: navigation, search
Tag: 2017 source edit
Tag: 2017 source edit
 
(16 intermediate revisions by the same user not shown)
Line 15: Line 15:
 
Contributor3: Andras Lasso - PerkLab, Queen's<br>
 
Contributor3: Andras Lasso - PerkLab, Queen's<br>
 
Contributor4: Maria Francesca Spadea, Magna Graecia University of Catanzaro - Italy<br>
 
Contributor4: Maria Francesca Spadea, Magna Graecia University of Catanzaro - Italy<br>
−
Contact: Paolo Zaffino, <email>p.zaffino@unicz.it</email><br>
+
Contact: Paolo Zaffino, p.zaffino@unicz.it<br>
 
{{documentation/{{documentation/version}}/module-introduction-row}}
 
{{documentation/{{documentation/version}}/module-introduction-row}}
  
Line 23: Line 23:
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
  
−
Arduino Connect: this module allows to connect Slicer and Arduino board. This will be use to build other modules and applications.
+
1. Arduino Connect: this module allows to connect Slicer and Arduino board. This will be use to build other modules and applications. The integration of the data coming from the board strongly relies on vtkMRMLScriptedModuleNode in order to notify to the entire system the arrival of a new data.
  
−
The integration of the data coming from the board strongly relies on vtkMRMLScriptedModuleNode in order to notify to the entire system the arrival of a new data.
 
  
 +
2. Arduino Motion Sensor: Module for 3D Slicer that allows to control the Slice View through gestures using an inexpensive motion sensor compatible with Arduino. (Module Icon made by Freepik from www.flaticon.com)
 +
 +
 +
Full documentation and examples available at:
 +
https://pzaffino.github.io/SlicerArduinoController/index
 +
 +
 +
If you use this extension please cite the following article:
 +
 +
Zaffino P, Merola A, Leuzzi D, Sabatino V, Cosentino C, Spadea MF.
 +
SlicerArduino: A Bridge between Medical Imaging Platform and Microcontroller.
 +
Bioengineering. 2020 Sep;7(3):109.
 +
 +
Journal link: https://www.mdpi.com/2306-5354/7/3/109
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Use Cases}}
 
{{documentation/{{documentation/version}}/module-section|Use Cases}}
  
 +
===Arduino Connect===
 
Users wants to connect, receive and transmit data from/to Arduino. Connection parameters can be set according to user environment.
 
Users wants to connect, receive and transmit data from/to Arduino. Connection parameters can be set according to user environment.
  
Line 39: Line 53:
 
|}
 
|}
  
−
<!-- ---------------------------- -->{{documentation/{{documentation/version}}/module-section|Tutorials}}
+
===Arduino Motion Sensor===
 +
Users want to control the Slice View module by using gestures detected via dedicated Arduino sensor.
 +
 
 +
<br />{{documentation/{{documentation/version}}/module-section|Tutorials}}
  
−
* Arduino Connect
+
===Arduino Connect===
 
  1. Connect Arduino to the system (user has to take care of Arduino code side).
 
  1. Connect Arduino to the system (user has to take care of Arduino code side).
−
  2. Set port and other connection parameters according to PC environment
+
  2. Click "Detect device(s)" button
−
  4. Click Connect button
+
3. Set port and other connection parameters according to PC environment
−
  5. Enjoy connection
+
  4. Click "Connect" button
 +
  5. Send receive data (via GUI and/or Python code)
 +
 
 +
===Arduino Motion Sensor===
 +
1. Connect PAJ7620 to “Arduino”. To do this simply connect:
 +
 
 +
  Vin to 3.3 V;
 +
 
 +
  Gnd to Gnd;
 +
 
 +
  SCL to SCL;
 +
 
 +
  SDA to SDA.
 +
2. Connect “Arduino” to the USB port of pc and and run “paj7620_9gestures” code on “arduino IDE”.
 +
 
 +
  The code can be found here: “https://github.com/Seeed-Studio/Gesture_PAJ7620”.
 +
 
 +
3. Connect “Arduino” to “3D Slicer” using “Slicer Arduino Controller” extension.
 +
 
 +
4. “ArduinoMotionSensor” extension in “3D Slicer”, choose the desidered offset variation and press “Start Motion” button.
 +
 
 +
5. Use the gestures for controlling view settings by exploiting the following options:
 +
 
 +
    “Left” = Select Previous View
 +
 
 +
    “Right” = Select Next View
 +
 
 +
    “Up” = Increase Offset
 +
 
 +
    “Down” = Decrease Offset
 +
 
 +
    “Forward” = Enable Full Screen
 +
 
 +
    “Backward” = Disable Full Screen
 +
 
 +
===Arduino Pedalboard===
 +
 
 +
Module for 3D Slicer that allows to control the Slice View through a pedealboard connected via Arduino.
 +
 
 +
 
 +
1. Connect buttons to Arduino as described in the figure below:
 +
 
 +
[[File:ArduinoPedalBoarad_schematic.png|500px]]
 +
 
 +
2. Load in Arduino board the code hosted into the folder "ArduinoCode/ArduinoPedalboard".
 +
 
 +
3. Connect “Arduino” to “3D Slicer” using “Slicer Arduino Controller” extension.
 +
 
 +
4. On “ArduinoPedalBoard” extension in “3D Slicer”, choose the desidered tasks and offset variation and press “Start” button.
 +
 
 +
5. Use the pedalboard for controlling view settings.
  
−
<!-- ---------------------------- -->
 
 
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
 
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
 +
 +
Simple panel to connect Arduino and to interact with it.
  
 
{|
 
{|
Line 61: Line 129:
 
{{documentation/{{documentation/version}}/module-section|References}}
 
{{documentation/{{documentation/version}}/module-section|References}}
  
 +
Zaffino P, Merola A, Leuzzi D, Sabatino V, Cosentino C, Spadea MF.
  
 +
SlicerArduino: A Bridge between Medical Imaging Platform and Microcontroller.
  
 +
Bioengineering. 2020 Sep;7(3):109.
 
<!-- ---------------------------- -->{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 
<!-- ---------------------------- -->{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 
{{documentation/{{documentation/version}}/module-developerinfo}}
 
{{documentation/{{documentation/version}}/module-developerinfo}}
 +
Full documentation and examples available at:
 +
https://pzaffino.github.io/SlicerArduinoController/index
 +
 +
Source code:
 
https://github.com/pzaffino/SlicerArduinoController
 
https://github.com/pzaffino/SlicerArduinoController
 +
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Latest revision as of 14:56, 11 April 2022

Home < Documentation < Nightly < Extensions < ArduinoController


For the latest Slicer documentation, visit the read-the-docs.


Introduction and Acknowledgements

Extension: ArduinoController
Author: Paolo Zaffino, Magna Graecia University of Catanzaro - Italy
Contributor1: Domenico Leuzzi, Magna Graecia University of Catanzaro - Italy
Contributor2: Virgilio Sabatino, Magna Graecia University of Catanzaro - Italy
Contributor3: Andras Lasso - PerkLab, Queen's
Contributor4: Maria Francesca Spadea, Magna Graecia University of Catanzaro - Italy
Contact: Paolo Zaffino, p.zaffino@unicz.it

Module Description

1. Arduino Connect: this module allows to connect Slicer and Arduino board. This will be use to build other modules and applications. The integration of the data coming from the board strongly relies on vtkMRMLScriptedModuleNode in order to notify to the entire system the arrival of a new data.


2. Arduino Motion Sensor: Module for 3D Slicer that allows to control the Slice View through gestures using an inexpensive motion sensor compatible with Arduino. (Module Icon made by Freepik from www.flaticon.com)


Full documentation and examples available at: https://pzaffino.github.io/SlicerArduinoController/index


If you use this extension please cite the following article:

Zaffino P, Merola A, Leuzzi D, Sabatino V, Cosentino C, Spadea MF. SlicerArduino: A Bridge between Medical Imaging Platform and Microcontroller. Bioengineering. 2020 Sep;7(3):109.

Journal link: https://www.mdpi.com/2306-5354/7/3/109

Use Cases

Arduino Connect

Users wants to connect, receive and transmit data from/to Arduino. Connection parameters can be set according to user environment.

A sender and a monitor/plotter of data coming from the board are also available without the need of writing code.

Arduino Connect module

Arduino Motion Sensor

Users want to control the Slice View module by using gestures detected via dedicated Arduino sensor.


= Tutorials =

Arduino Connect

1. Connect Arduino to the system (user has to take care of Arduino code side).
2. Click "Detect device(s)" button
3. Set port and other connection parameters according to PC environment
4. Click "Connect" button
5. Send receive data (via GUI and/or Python code)

Arduino Motion Sensor

1. Connect PAJ7620 to “Arduino”. To do this simply connect: 

  Vin to 3.3 V;
 
  Gnd to Gnd;
 
  SCL to SCL; 
 
  SDA to SDA.

2. Connect “Arduino” to the USB port of pc and and run “paj7620_9gestures” code on “arduino IDE”. 

  The code can be found here: “https://github.com/Seeed-Studio/Gesture_PAJ7620”.

3. Connect “Arduino” to “3D Slicer” using “Slicer Arduino Controller” extension.

4. “ArduinoMotionSensor” extension in “3D Slicer”, choose the desidered offset variation and press “Start Motion” button.

5. Use the gestures for controlling view settings by exploiting the following options: 

   “Left” = Select Previous View

   “Right” = Select Next View

   “Up” = Increase Offset

   “Down” = Decrease Offset

   “Forward” = Enable Full Screen

   “Backward” = Disable Full Screen

Arduino Pedalboard

Module for 3D Slicer that allows to control the Slice View through a pedealboard connected via Arduino.


1. Connect buttons to Arduino as described in the figure below:

ArduinoPedalBoarad schematic.png

2. Load in Arduino board the code hosted into the folder "ArduinoCode/ArduinoPedalboard".

3. Connect “Arduino” to “3D Slicer” using “Slicer Arduino Controller” extension.

4. On “ArduinoPedalBoard” extension in “3D Slicer”, choose the desidered tasks and offset variation and press “Start” button.

5. Use the pedalboard for controlling view settings.

Panels and their use

Simple panel to connect Arduino and to interact with it.

Arduino Connection Module UI

Similar Modules

References

Zaffino P, Merola A, Leuzzi D, Sabatino V, Cosentino C, Spadea MF.

SlicerArduino: A Bridge between Medical Imaging Platform and Microcontroller.

Bioengineering. 2020 Sep;7(3):109.

Information for Developers

Work in progress
 Section under construction.


Full documentation and examples available at: https://pzaffino.github.io/SlicerArduinoController/index

Source code: https://github.com/pzaffino/SlicerArduinoController

Retrieved from "https://www.slicer.org/w/index.php?title=Documentation/Nightly/Extensions/ArduinoController&oldid=64051"