diff --git a/Air-track/Air-track_instructions.md b/Air-track/Air-track_instructions.md index 9858284..555ad1a 100644 --- a/Air-track/Air-track_instructions.md +++ b/Air-track/Air-track_instructions.md @@ -2,6 +2,12 @@ In this paradigm, head-fixed mice perform a visual two-alternative forced choice task. This setup can be adapted to accommodate more sensory modalities by using appropriate equipment. +
+
+ +
+
+ ## πŸ“¦ Hardware parts list ### πŸ”Œ Electronics @@ -46,27 +52,29 @@ In this paradigm, head-fixed mice perform a visual two-alternative forced choice ### 🧩 3D printed parts -You will find the blueprints for the items you should 3D print [here](ethopy_hardware/Air-track/3d_designs). +You will find the blueprints for the items you should 3D print [here](https://github.com/ef-lab/ethopy_hardware/tree/main/Air-track/3d_designs). | # |Item |Qty |Filename | |:-:|:-: |:-: |:-: | -|1 |screen holders |2 |[screen_holder.stl](ethopy_hardware/Air-track/3d_designs/screen_holder.stl) | +|1 |screen holders |2 |[screen_holder.stl](https://github.com/ef-lab/ethopy_hardware/blob/main/Air-track/3d_designs/screen_holder.stl) | ## πŸ› οΈ Step-by-step assembly instructions -You will find the blueprints for the items you should 3D print [here](3d_designs). +You will find the blueprints for the items you should 3D print [here](https://github.com/ef-lab/ethopy_hardware/tree/main/Air-track/3d_designs). > :bulb: **Info:** The air-table ([see Other Hardware, part #1](#hardware1)) and platform ([see Other Hardware, part #2](#hardware2)) of the air-track were developed by Dr. Mostafa A. Nashat and assembly (https://doi.org/10.1152/jn.00088.2016, https://doi.org/10.1101/2024.08.22.608577). -**Step 1**. Set up the [Raspberry Pi Behavioral Setup](ethopy_hardware/Homecage/RP_instructions.md) following steps 1-7, modifying Raspberry Pi Behavioral Setup Step 5 to connect only the valves ([see Electronics, part #2](#electro2)) to the EthoPy Controller Board. +**Step 1**. Set up the [Raspberry Pi Behavioral Setup](https://github.com/ef-lab/ethopy_hardware/blob/main/Homecage/RP_instructions.md) following steps 1-7, modifying Raspberry Pi Behavioral Setup Step 5 to connect only the valves ([see Electronics, part #2](#electro2)) to the EthoPy Controller Board. **Step 2**. Mount the Raspberry Pi Behavioral Setup on the screen holders ([see 3D printed parts, part #1](#printed1)) in front of the air-table ([Fig. 1](#fig1)). +
Figure 1: The RP behavioral setup, mounted on the aluminum rails of the air-table using the screen holders.
+
**Step 3**. Assembling of a behavior port ([see Other Hardware, part #3](#hardware3)). Mounting of the infrared emitter ([see Electronics, part #3](#electro3)) and phototransistor ([see Electronics, part #4](#electro4)) to the port was performed following the instructions provided [here](https://sanworks.github.io/Bpod_Wiki/assembly/mouse-behavior-port-assembly/). Each platform included three behavior ports. @@ -84,10 +92,12 @@ You will find the blueprints for the items you should 3D print [here](3d_designs **Step 7**. Remove the insulation from the edge of the Ethernet wires. Place 13 female terminals ([see Other Hardware, part #4](#hardware4)) at the end of each wire and cover the exposed terminal with insulation (e.g., heat shrink tube, [see Other Hardware, part #9](#hardware9)). In the following steps, the identification of the Ethernet cable wires is shown in ([Fig. 2](#fig2)). +
Figure 2: Ethernet cable wire number ids.
+
> :memo: **Note:** You will use the wires 1 (signal of the sensor), 4 (power of the emitter), 5 (ground). @@ -99,15 +109,16 @@ You will find the blueprints for the items you should 3D print [here](3d_designs > :memo: **Note:** Power cables and grounds should be short-circuited together to connect to one pin of the Raspberry Pi. -**Step 9**. Driving of the valves for ports 1 and 2 using the [`EthoPy Controller Board`](ethopy_hardware/Homecage/EthoPy_Controller_Board.md). +**Step 9**. Driving of the valves for ports 1 and 2 using the [`EthoPy Controller Board`](https://github.com/ef-lab/ethopy_hardware/blob/main/EthoPy_Controller/EthoPy_Controller_Board.md). **Step 10**. Adjust the reward tubes ([see Other Hardware, part #5](#hardware5), [part #6](#hardware6)) to the behavioral port and connect the valves. Bridge the valves and connect to the water supply ([Fig. 3](#fig3)). +
Figure 3: Solenoid valve with the positions of the tubes
- +
**Step 11**. If sound/light insulation is needed, the Air-track behavioral system can be enclosed in the [`Rat-Rig V-Hive Enclosure Base Model`](https://ratrig.dozuki.com/Guide/01.+V-Hive+Enclosure+Base+Model/183?lang=en) ([see Other Hardware, part #7](#hardware7)). For further sound and light insulation, related insulation material (e.g. ISOLFON foam plate, see ([see Other Hardware, part #8](#hardware8))) can be used to cover the sides of the enclosure. diff --git a/Air-track/figures/Fig.png b/Air-track/figures/Fig.png new file mode 100644 index 0000000..9e6d190 Binary files /dev/null and b/Air-track/figures/Fig.png differ diff --git a/EthoPy_Controller/EthoPy_Controller_Board.md b/EthoPy_Controller/EthoPy_Controller_Board.md index 69bfa76..52d6fa8 100644 --- a/EthoPy_Controller/EthoPy_Controller_Board.md +++ b/EthoPy_Controller/EthoPy_Controller_Board.md @@ -1,6 +1,7 @@ # EthoPy Controller Board and Arduino Arduino is a microcontroller that converts the analog signal from the lick and proximity ports to digital, and a Controller Board ensures the communication between the Arduino and Raspberry Pi. +
@@ -48,10 +49,12 @@ Arduino is a microcontroller that converts the analog signal from the lick and p |15 | Printed Circuit Board (PCB) | 1 | Custom | β€” | | +
Figure 1: EthoPy Controller Board and Arduino parts
+
> :memo: **Note:** You will also need: a soldering iron, a wire cutter @@ -59,77 +62,101 @@ Arduino is a microcontroller that converts the analog signal from the lick and p **Step 1**. Print the PCB board of the schematic ([Fig. 2](#fig2)). PCB and gerder files for JLPCB are available [here](). +
+
**Step 2**. Solder the 1x15 female pin headers on each side of the Arduino Nano Every board ([Fig. 3](#fig3)). +
+
**Step 3**. Solder each resistor into its designated position on the PCB according to its resistance value ([Fig. 4](#fig4)). +
+
**Step 4**. Solder the five 1x2 male pins headers into the corresponding ports on the PCB ([Fig. 5](#fig5)). +
+
**Step 5**. Solder the transistors onto their correct positions on the board ([Fig. 6](#fig6)). +
+
**Step 6**. Solder the diodes in the same way ([Fig. 7](#fig7)). +
+
**Step 7**. Solder the tactile push button switch in the appropriate position on the board ([Fig. 8](#fig8)). +
+
**Step 8**. Solder the capacitor, ensuring the longer positive lead goes into the right hole ([Fig. 9](#fig9)). +
+
**Step 9**. Solder the right-angle female pin headers - two on the left side (1x2) for valves and three on the bottom (1x3) for ports and centerport ([Fig. 10](#fig10)). +
+
**Step 10**. Solder the two 1x15 female pin headers for the Arduino board ([Fig. 11](#fig11)). +
+
**Step 11**. Mount the Arduino board onto the previously mentioned female pin headers ([Fig. 12](#fig12)). +
+
**Step 12**. Solder the 40-pin extra-tall stackable female header to connect the PCB to the Raspberry Pi board ([Fig. 13](#fig13)). +
+
-**Step 13**. Set up the Arduino using the code provided [here](). +**Step 13**. Set up the Arduino using the code provided [here](https://github.com/ef-lab/ethopy_hardware/blob/main/EthoPy_Controller/EthoPy_Controller_code.ino). diff --git a/Homecage/Lick_ports_assemply.md b/Homecage/Lick_ports_assemply.md index d9cb299..c178339 100644 --- a/Homecage/Lick_ports_assemply.md +++ b/Homecage/Lick_ports_assemply.md @@ -57,28 +57,34 @@ Lick Ports are used both for lick detection and reward delivery. Regarding the f - `Pin 3`: collector of the sensor (current flow after light reflection) - `Pin 4`: emitter of the sensor (connects to the signal output) +
Figure 1: Positions of the phototransistor’s pins and their corresponding wires.
+
**Step 5**. Use the soldering station to connect the pins vertically to their corresponding wires as described below ([Fig. 2](#fig2)). **Step 6**. Use a hot air gun to heat the heat shrink tubes you have added to each wire to cover the wire and the phototransistor’s pins. +
Figure 2: Heat shrink tubes covering the exposed wires and the phototransistor’s pins.
+
**Step 7**. Cut a piece of heat shrink tube (3/16’’) long enough to cover the exposed cable and the pins of the phototransistor, and pass it down the cable. Ξ‘pply the epoxy glue ([Other Hardware parts list, item #6](#other6)) to the exposed section of the cable and cover it up to the edge. Cover the exposed cable with the heat shrink tube and use the hot air gun to heat it. Ensure that the phototransistor’s pins and the wires are well covered. Note: As the hot air gun shrinks the tube, ensure that the epoxy glue will not cover the phototransistor. +
Figure 3: Heat shrink tube covering the phototransistor side of the lick port.
+
**Step 8**. Cut a steel cylinder ([Other Hardware parts list, item #2](#other2)). long enough to cover the heat shrink tube that covers the exposed wires ([Fig. 4](#fig4)). Carefully smooth both edges of the cylinder with sandpaper to ensure the mouse is not injured while licking it. @@ -87,17 +93,21 @@ Note: As the hot air gun shrinks the tube, ensure that the epoxy glue will not c > :memo: **Note:** The needle is required only if you will use the lick port for reward delivery. +
Figure 4: Indicative lengths of the steel cylinder and the needle relative to the lick port.
+
**Step 10**. Pass the phototransistor cable and the needle through the steel cylinder. Apply epoxy glue around the heat shrink tube insulation of the phototransistor ([Fig. 5](#fig5)) and the needle, ensuring that the phototransistor’s and the needle’s tops are not covered with glue. Pull the cable and the needle so that they are on the same level and a few millimeters below the top of the steel cylinder to prevent possible damage. Fill all the empty spaces between the phototransistor and the cylinder with epoxy glue. +
Figure 5: Phototransistor end of the lick port.
+
### Connecting the cable to the resistors @@ -107,24 +117,30 @@ You will need two resistors: **Step 11**. Shorten the wire connected to the anode and expose the conductor. Cut both ends of the 330Ξ© resistor ([Electronics parts list, item #3](#electro3)) and use soldering to connect the 330Ξ© resistor to the wires connected to the anode and the collector. Solder the resistor horizontally across the cable, connecting the distal pin to the collector wire and the proximal pin to the anode wire ([Fig. 6](#fig6)). +
Figure 6: Connections of the 330Ξ© resistor.
+
**Step 12**. Shorten the wire connected to the emitter and expose the conductor. Ξ’end one of the pins of the 47KΞ© resistor ([Electronics parts list, item #4](#electro4)). Use soldering to connect the cathode wire to the straight pin and the emitter wire to the other pin ([Fig. 7](#fig7)). +
Figure 7: Connections of the 47kΞ© resistor.
+
**Step 13**. Use a male pin header ([Other Hardware parts list, item #4](#other4)) with 3 pins and connect it to the cable ([Fig. 8](#fig8)). Mark the tip that is connected to the bent pin of the 47kΞ© resistor so you can distinguish it (it corresponds to the signal). +
Figure 8: Connections of the signal cable (P: power, G: ground, S: signal).
+
**Step 14**. Cover the exposed cable and the proximal part of the male pin header with heat shrink tube (1/4’’ or 3/8’’), and heat it with the hot air gun. @@ -136,8 +152,10 @@ You will need two resistors: **Step 17**. Use your finger to simulate the lick of a mouse and observe the activation of the phototransistor ([Fig. 9](#fig9)). +
Figure 9: Sensor voltage output (left: connections of the power supply and the oscilloscope, right: activation of the phototransistor).
-
\ No newline at end of file +
+
\ No newline at end of file diff --git a/Homecage/RP_instructions.md b/Homecage/RP_instructions.md index 966faae..8a11e9c 100644 --- a/Homecage/RP_instructions.md +++ b/Homecage/RP_instructions.md @@ -21,15 +21,15 @@ A key component of multiple Ethopy behavioral systems is the [Raspberry Pi](http | 3 | Premium High Speed microSD Card | 1 | Integral | INMSDH32G-100/70V30 | | -| 4 | EthoPy Controller Board | 1 | [Custom](ethopy_hardware/Homecage/EthoPy_Controller_Board.md) | | | +| 4 | EthoPy Controller Board | 1 | [Custom](https://github.com/ef-lab/ethopy_hardware/blob/main/EthoPy_Controller/EthoPy_Controller_Board.md) | | | -| 5 | Lick Ports | 2 or 3 | [Custom](ethopy_hardware/Homecage/Lick_ports_assemply.md) | | 2 to detect licks and deliver water, 1 can be used as a proximity indicator (center port) | +| 5 | Lick Ports | 2 or 3 | [Custom](https://github.com/ef-lab/ethopy_hardware/blob/main/Homecage/Lick_ports_assemply.md) | | 2 to detect licks and deliver water, 1 can be used as a proximity indicator (center port) | | 6 | Beam Photoelectric Sensor | 1 | HAITRONIC | HR0172 |Can be used as a proximity indicator (center port) | | 7 | Solenoid valves | 2 | LEE SLR | LHDA0533415H | | -| 8 | Ultrasound Speakers 40kHz | 2 | PUI Audio | UT-1640K-TT-2-R |For auditory experiments. See: [Speakers_assemply](ethopy_hardware/Homecage/Speakers_assemply.md) | +| 8 | Ultrasound Speakers 40kHz | 2 | PUI Audio | UT-1640K-TT-2-R |For auditory experiments. See: [Speakers_assemply](https://github.com/ef-lab/ethopy_hardware/blob/main/Homecage/Speakers_assemply.md) | ### πŸ”§ Other Hardware @@ -41,21 +41,22 @@ A key component of multiple Ethopy behavioral systems is the [Raspberry Pi](http | 2 | Raspberry Pi 4 Heatsink (40x30x5mm) | 1 | Grobotronics | 49-00012076 | | ### 🧩 3D printed parts -You will find the blueprints for the items you should 3D print [here](ethopy_hardware/Homecage/3d_designs). +You will find the blueprints for the items you should 3D print [here](https://github.com/ef-lab/ethopy_hardware/tree/main/Homecage/3d_designs). | # | Item | Qty | Filename | Notes | |:-:|:-: |:-: |:-: |:-: | -| 1 | Base | 1 | [base.stl](ethopy_hardware/Homecage/3d_designs/base.stl) | Includes the lick port holders | -| 2 | Screen holder | 2 | [screen_holder.stl](ethopy_hardware/Homecage/3d_designs/screen_holder.stl) | | -| 3 | Center port holder | 1 | [center_port.stl](ethopy_hardware/Homecage/3d_designs/center_port.stl) | | -| 4 | Center port & speaker holder | 1 | [center_port_with_speakers.stl](ethopy_hardware/Homecage/3d_designs/center_port_with_speakers.stl) | Includes speaker holders | -| 5 | Pins | 1 | [pin.stl](ethopy_hardware/Homecage/3d_designs/pin.stl) | For mounting the center port holder | - +| 1 | Base | 1 | [base.stl](https://github.com/ef-lab/ethopy_hardware/blob/main/Homecage/3d_designs/base.stl) | Includes the lick port holders | +| 2 | Screen holder | 2 | [screen_holder.stl](https://github.com/ef-lab/ethopy_hardware/blob/main/Homecage/3d_designs/screen_holder.stl) | | +| 3 | Center port holder | 1 | [center_port.stl](https://github.com/ef-lab/ethopy_hardware/blob/main/Homecage/3d_designs/center_port.stl) | | +| 4 | Center port & speaker holder | 1 | [center_port_with_speakers.stl](https://github.com/ef-lab/ethopy_hardware/blob/main/Homecage/3d_designs/center_port_with_speakers.stl) | Includes speaker holders | +| 5 | Pins | 1 | [pin.stl](https://github.com/ef-lab/ethopy_hardware/blob/main/Homecage/3d_designs/pin.stl) | For mounting the center port holder | +
Figure 1: RP setup (top: 3D printed parts of the RP’s base, bottom: assembled RP base).
+
## πŸ› οΈ Step-by-step assemply instructions @@ -68,17 +69,19 @@ You will find the blueprints for the items you should 3D print [here](ethopy_har **Step 4**. Add a heatsink ([Other Hardware parts list, item #2](#other2)) on the back of the RP to avoid excessive warming. -**Step 5**. Plug in the side and the center ([lick](ethopy_hardware/Homecage/Lick_ports_assemply.md) or interruptor) ports, and the valves to the EthoPy Controller Board, to the positions indicated on the board. +**Step 5**. Plug in the side and the center ([lick](https://github.com/ef-lab/ethopy_hardware/blob/main/Homecage/Lick_ports_assemply.md) or interruptor) ports, and the valves to the EthoPy Controller Board, to the positions indicated on the board. **Step 6**. Connect the valves to the water supply. Each LEE valve ([Electronics parts list, item #7](#electro7)) has 3 pipe-edges (1) to be connected to the lick port tube, (2) to be connected with the water supply tube, and (3) to be connected with the other valve through a tube and 2 pins to be connected to the board ([Fig. 2, left](#fig1)). In the RP setup, the upper valve corresponds to the left lick port, and the bottom valve corresponds to the right lick port ([Fig. 2, right](#fig1)). +
Figure 2: Connections of the solenoid valve (left: positions of the tubes, right: placement of the valves on the RP board).
+
**Step 7**. Connect to the RPi and run a test task. @@ -86,7 +89,7 @@ In the RP setup, the upper valve corresponds to the left lick port, and the bott > For more information, visit their: [Rasberry Pi: Remote access](https://www.raspberrypi.com/documentation/computers/remote-access.html) -- Follow the instructions on how to [install/run EthoPy](https://ef-lab.github.io/ethopy_package/installation/) +- Follow the instructions on how to [install/run EthoPy](https://ef-lab.github.io/ethopy_package/installation.html) > :memo: **Note (Optional):** Rename the RP and set a static IP address. diff --git a/Homecage/Speakers_Figures/Fig7.png b/Homecage/Speakers_Figures/Fig7.png index a449df8..1106ea3 100644 Binary files a/Homecage/Speakers_Figures/Fig7.png and b/Homecage/Speakers_Figures/Fig7.png differ diff --git a/Homecage/Speakers_assemply.md b/Homecage/Speakers_assemply.md index aff78fd..7f3a99f 100644 --- a/Homecage/Speakers_assemply.md +++ b/Homecage/Speakers_assemply.md @@ -25,60 +25,64 @@ Speakers are used to provide auditory cues during behavioral experiments. They c ### 🧩 3D printed parts -You will find the blueprints for the item you should 3D print [here](3d_designs/center_port_with_speakers.stl). +You will find the blueprints for the item you should 3D print [here](https://github.com/ef-lab/ethopy_hardware/blob/main/Homecage/3d_designs/center_port_with_speakers.stl). ## πŸ› οΈ Step-by-step assemply instructions **Step 1**. Select four long female-to-female jumper wires and connect one end of each to the pins of the speaker ([Fig. 1](#fig1)). Repeat this step twice. +
Figure 1: Speaker connected with female-to-female jumper wires
- +
**Step 2**. Remove the square female heads from the other ends of the wires. **Step 3**. Solder the ends of two jumper wire (one from each speaker) together along with one small female-to-female jumper wire (after removing its square female head) ([Fig. 2](#fig2)). +
Figure 2: Soldering ends of two jumper wires
+
**Step 4**. Cut a piece of heat shrink tube long enough to cover the exposed wires ([Fig. 3](#fig3)). +
Figure 3: Coverd part with heat shrink tube
+
**Step 5**. Use the oscilloscope and connect one end (measuring clip) to one wire of the speaker and the grounding clip to the other wire ([Fig. 5](#fig5)). +
Figure 5: .....
+
**Step 6**. Connect your speakers to your Raspberry Pi Pinout. First, go to the `EthoPy/Interfaces/RPPorts.py` and look at the `class RPPorts(Interface)`. Here, you see which channel corresponds to the RP GPIO pins based on what you want to connect. So, for **sound** is channel `GPIO 13` ([Fig. 6](#fig6)). +
Figure 6: Hardware mapping of behavioral sensor ports to GPIO pins
+
Connect one wire of your speaker to `GPIO13` and the other wire to `ground`([Fig. 7](#fig7)). +
- +
Figure 7: Rasberry Pi's GPIO pins
+
-**Step 7**. Open your RP and run a task with auditory stimuli. - - \ No newline at end of file +**Step 7**. Open your RP and run a task with auditory stimuli. \ No newline at end of file diff --git a/Open-field/Open-field_instructions.md b/Open-field/Open-field_instructions.md index 4f64506..7009070 100644 --- a/Open-field/Open-field_instructions.md +++ b/Open-field/Open-field_instructions.md @@ -11,7 +11,7 @@ In this protocol, the open-field behavioral setup is used to allow freely-moving | 1 | Arduino Nano Every Board | 1 | Arduino Store | ABX00028 | | -| 2 | PCB Controller Board | 1 | JLCPCB (JiaLiChuang (HongKong) Co., LTD) | [custom](ethopy_hardware/Homecage/EthoPy_Controller_Board.md)| | +| 2 | PCB Controller Board | 1 | JLCPCB (JiaLiChuang (HongKong) Co., LTD) | [custom](https://github.com/ef-lab/ethopy_hardware/blob/main/EthoPy_Controller/EthoPy_Controller_Board.md)| | | 3 | 13.3" Capacitive Touch Screen LCD | 1 | Waveshare | HDMI LCD (H) | Presentation of stimuli, with Toughened Glass Cover, 1920Γ—1080 | @@ -44,17 +44,19 @@ In this protocol, the open-field behavioral setup is used to allow freely-moving | 11| V-Slot Gantry Set 2020 with Three Wheels | 2 | Grobotronics | 14-00020155 | | -| 12| Lickport | 1 | _ | [Custom](ethopy_hardware/Homecage/Lick_ports_assemply.md) | Delivers water | +| 12| Lickport | 1 | _ | [Custom](https://github.com/ef-lab/ethopy_hardware/blob/main/Homecage/Lick_ports_assemply.md) | Delivers water | | 13| LHD Series 3-Way Control Solenoid Valve | 1 | Lee SLR | LHDA0533415H | | ### 🧩 3D Printed Parts +You will find the blueprints for the items you should 3D print [here](https://github.com/ef-lab/ethopy_hardware/tree/main/Open-field/3d_designs). + | # | Item | Qty | Filename | Notes | |:-:|:-: |:-: |:-: |:-: | -| 1 | Lower Corners | 4 | [open-field_bottom_corner.stl](ethopy_hardware/Open-field/3d_designs/open-field_bottom_corner.stl) | | -| 2 | Upper Corners | 4 | [open-field_top_corner.stl](ethopy_hardware/Open-field/3d_designs/open-field_top_corner.stl) | | +| 1 | Lower Corners | 4 | [open-field_bottom_corner.stl](https://github.com/ef-lab/ethopy_hardware/blob/main/Open-field/3d_designs/open-field_bottom_corner.stl) | | +| 2 | Upper Corners | 4 | [open-field_top_corner.stl](https://github.com/ef-lab/ethopy_hardware/blob/main/Open-field/3d_designs/open-field_top_corner.stl) | | --- @@ -109,11 +111,11 @@ The interior of the enclosure consists of a plexiglass box (arena), where the mo ### 🧰 Arduino Board -**Step 6**. Follow instructions for [EthoPy Controller Board](ethopy_hardware/Homecage/Ethopy_Controller_Board.md) +**Step 6**. Follow instructions for [EthoPy Controller Board](https://github.com/ef-lab/ethopy_hardware/blob/main/EthoPy_Controller/EthoPy_Controller_Board.md) ### πŸ’§ Lickport -**Step 7**. Follow instructions [here](ethopy_hardware/Homecage/Lick_ports_assemply.md) to make the lickport ([Other Hardware list, item #12](#other12)). +**Step 7**. Follow instructions [here](https://github.com/ef-lab/ethopy_hardware/blob/main/Homecage/Lick_ports_assemply.md) to make the lickport ([Other Hardware list, item #12](#other12)). **Step 8**. Connect the lickport to the arduino board and a solenoid valve ([Other Hardware list, item #13](#other13)) in a pressurized tubing network (STAR methods, liquid delivery). diff --git a/README.md b/README.md index edb214a..12746e2 100644 --- a/README.md +++ b/README.md @@ -6,25 +6,43 @@ Welcome to the **Hardware for EthoPy** repository! This collection includes all This repo includes one folder for each behavioral system supported by EthoPy with the: - **Instructions** – step-by-step guides to build this setup and parts list - +- **Figures** - Photos illustrating the construction process and final setup - **3d_designs** – ready-to-print `.stl` files ## πŸ“ File Structure ```bash +β”œβ”€β”€ Air-track +β”‚ β”œβ”€β”€ 3d_designs +β”‚ β”œβ”€β”€ Air-track_instructions.md +β”‚ └── figures +β”œβ”€β”€ EthoPy_Controller +β”‚ β”œβ”€β”€ Controller_Figures +β”‚ β”œβ”€β”€ EthoPy_Controller_Board.md +β”‚ β”œβ”€β”€ EthoPy_Controller_code.ino +β”‚ β”œβ”€β”€ Lick_Valves_final.jpg +β”‚ β”œβ”€β”€ Lick_Valves_final.kicad_pcb +β”‚ β”œβ”€β”€ Valve_Controller.pdf +β”‚ └── gerbers +β”œβ”€β”€ Homecage +β”‚ β”œβ”€β”€ 3d_designs +β”‚ β”œβ”€β”€ Lick_ports_Figures +β”‚ β”œβ”€β”€ Lick_ports_assemply.md +β”‚ β”œβ”€β”€ RP_Figures +β”‚ β”œβ”€β”€ RP_instructions.md +β”‚ β”œβ”€β”€ Speakers_Figures +β”‚ └── Speakers_assemply.md +β”œβ”€β”€ LICENSE +β”œβ”€β”€ Open-field +β”‚ β”œβ”€β”€ 3d_designs +β”‚ β”œβ”€β”€ Open-field_Figures +β”‚ └── Open-field_instructions.md β”œβ”€β”€ README.md -β”œβ”€β”€ Homecage/ -β”‚ └── README.md -β”‚ └── Instructions.pdf -β”‚ └── 3d_designs -β”‚ └── base.stl -β”‚ └── screen_holder.stl -β”‚ └── ... -β”œβ”€β”€ Openfield/ -β”‚ └── ... -β”œβ”€β”€ Air-track/ -β”‚ └── ... +└── Spherical_Treadmill + β”œβ”€β”€ 3d_design + β”œβ”€β”€ figures + └── spherical_treadmill_instructions.md ``` , 4 odours to define an olfactory virtual environment, and a mouthpiece to deliver the odors but also the reward. -**Step 1**. Set up the [Raspberry Pi Behavioral Setup](ethopy_hardware/Homecage/RP_instructions.md) following steps 1-5, the difference is that in this setup you need 5 valves ([Electronics parts list, item #1](#electro1)), for reward and 4 for odour delivery. +**Step 1**. Set up the [Raspberry Pi Behavioral Setup](https://github.com/ef-lab/ethopy_hardware/blob/main/Homecage/RP_instructions.md) following steps 1-5, the difference is that in this setup you need 5 valves ([Electronics parts list, item #1](#electro1)), for reward and 4 for odour delivery. **Step 2**. A `Styrofoam ball` is supported by three (3) metallic ball bearings ([Other Hardware parts list, item #1](#other1)) allowing smooth navigation for prolonged periods. The bearings are supported by custom 3D-printed posts ([3D-printed parts, part #2](#printer2)) at a 45Β° angle, so the ball is stable while the subject is performing the task. @@ -84,11 +90,24 @@ Following instructions apply for any virtual reality system that uses a styrofoa - `Valves’ control circuit`: To control the valves, we use a MOSFET board ([Electronics parts list, item #2](#electro2)) and connect the power and ground of the valve to the board, placing the power at position 2a and the ground at position 2b shown in [Fig. 4](#fig4). Then, to connect it with the Raspberry Pi, we select the pin of the RP we have programmed to trigger the valve and a ground pin and connect the other end to the PWR and GND pins respectively placed at the top part of the board (position 3, ([Fig. 4](#fig4))). Lastly, to turn on the board we need to insert 2 cables at position 1, one for the power and one for the ground of the power supply. In this last step, it is advised to make a 6-way cable assembly, both for the power and the ground, 5 of them going to each MOSFET board, and one connecting the power supply. This assembly can be placed in a plastic box ([Other Hardware parts list, item #2](#other2)). - +
+
+ + +
Figure 4: MOSFET boards for controlling the valves for the odorants
+
+
- `Lick detector circuit`: The Capacitive sensor board ([Electronics parts list, item #3](#electro3)) consists of five pins: GND for ground, OUT for signal, VDD for power supply (1.8V - 5V), LED and PAD ([Fig. 5](#fig5)). In this case, only four of the pins are required (GND, OUT, VDD, and PAD). To connect the sensor for the lick detection it is important to solder a trimmed and polished 18G needle to the wire that will connect with the PAD pin. - +
+
+ + + +
Figure 5: Capacitive Touch Breakout board and Mouthpiece
+
+
- `Laser mice`: Connect the laser mice to the two USB ports of the RP (each USB port will be assigned later in EthoPy code (Interfaces/Ball.py) to determine which laser mouse is responsible for decoding which axes)