Skip to content

Getting_Started.md

Latest commit

 

History

History
569 lines (455 loc) · 38.9 KB

Getting_Started.md

File metadata and controls

569 lines (455 loc) · 38.9 KB
Raw

Getting Started with EmotiBit

Welcome to EmotiBit! This guide will walk you through unboxing, setting up your hardware, and visualizing data for the first time.

Follow these steps in order to validate that your hardware is working perfectly. Even if you don't plan to use the Oscilloscope or record data immediately for your specific project, completing this walkthrough ensures your entire ecosystem is fully functional.

Table of Contents

Caution

ELECTRICAL SHOCK WARNING
EmotiBit should NEVER be worn while electrically connected to any device that's attached to A/C wall power. Connecting EmotiBit USB or any other pin to another device can be a shock risk hazard and should ONLY be done when EmotiBit is NOT in physical contact with the body.

Learn About EmotiBit

What's in the Box? (Unboxing Component Guide)

Before you begin, make sure you have all the components included in your EmotiBit package: The following sections explain the contents of each item available for purchase at the shop.EmotiBit.com:

Item Contents Image
EmotiBit
  • 1x EmotiBit with finger loop Emoti-stretch strap
    • Depending on your purchase, you may either have an EmotiBit MD or an EmotiBit EMO
  • 1x Emoti-genic barrier (provides an additional hygienic layer and sweat protection)
  • 2x EDA electrodes (Ag/AgCl) attached to the EmotiBit
  • 2x EmotiBit stickers
Essentials Kit Already have an EmotiBit? The Essentials Kit contains everything else you will need to get started. In the box you will find:

  • Adafruit Feather M0 WiFi or Adafruit Feather ESP32 Huzzah
  • 400mAh Lithium ion battery
  • High-speed microSD card (inside the MicroSD card reader)
  • MicroSD card reader
  • Micro USB cable
  • 3x Emoti-stretch straps of different lengths (to wear EmotiBit nearly anywhere on the body, ranging from a child’s wrist to an adult's head)
  • Plastic spudger (used to easily toggle the hibernate switch and EmotiBit button)
Electrodes Kit The electrodes kit has been designed for users who use multiple EmotiBits for research and intend to frequently swap out the electrodes. The electrodes kit includes:

  • 10x EDA electrodes (Ag/AgCl)
  • 4x solder-cup snaps (to add your own EDA leads)
  • 5x Emoti-genic barriers (provides an additional hygienic layer and sweat protection)
All-in-One Bundle If you purchased the All-in-One Bundle, you will receive the EmotiBit, Essentials Kit, and Electrodes Kit components detailed above. (Includes all items pictured above)

Compatible Feather Modules

Warning

If you are using your EmotiBit with a Feather not included as a part of the All-in-One Bundle or the Essentials Kit, please verify that you are using one of the 2 compatible Feathers. Using EmotiBit with any other Feather module will not work.

  • Click this drop-down to see the compatible feathers
    Adafruit Feather ESP32 Huzzah Adafruit Feather M0 WiFi
    Feather ESP32 Huzzah Feather M0 WiFi

Understanding the Hardware: EmotiBit vs. Feather

To get the most out of your device, it helps to understand how the two core boards work together as a team:

  • The EmotiBit is the sensor module. It contains the dedicated biometric circuitry, specialized analog-to-digital converters, and high-fidelity sensors. It also features its own dedicated status LEDs and control buttons.
  • The Adafruit Feather is the controller (MCU). It provides the main microprocessor, handles the software firmware execution, and manages the wireless network communication (WiFi) or local storage. It also has its own onboard LEDs and buttons distinct from the EmotiBit.
    Combining these two components creates a stacked EmotiBit.

How EmotiBit Works & Communicates

EmotiBit is designed for real-time wireless data streaming and requires a local WiFi (or mobile hotspot) network. Both the EmotiBit and the computer(host) running the EmotiBit Oscilloscope application MUST be connected to the same WiFi(hotspot) network.

  1. The EmotiBit Device: The firmware running on the Feather board (stacked EmotiBit) processes raw sensor data from the EmotiBit and packages it.
  2. The Network Bridge: The EmotiBit device transmits this data wirelessly over the local WiFi network.
  3. The EmotiBit Oscilloscope application: Your computer runs the EmotiBit Oscilloscope application software. The Oscilloscope listens to the network, automatically detects the EmotiBit, and streams the biometric data to your screen in real time.

Important

Network Dependence: Because the data passes through your local network, both your computer (running the EmotiBit Oscilloscope) and the EmotiBit must be connected to the exact same WiFi network. If your network has security settings that block device-to-device communication (common on enterprise or university networks), the data will not reach the screen. Don't worry—we will walk you through configuring and troubleshooting this during the setup phase!

Setup Steps

1. Download and Install the Software Bundle

The software applications(EmotiBitFirmwareInstaller, EmotiBitOscilloscope, and EmotiBitDataParser) required to interface with EmotiBit are distributed on our GitHub page.

  • 1.1 Navigate to the EmotiBit GitHub Releases Page and download the asset bundle compatible with your operating system.

  • 1.2 OS-Specific Installation Instructions:

    • Installation Instructions For Windows Users
      • Note: EmotiBit software is supported only on Windows 10+.
      • After downloading EmotiBitSoftware-Windows.zip, extract the zip file by right-clicking the file and selecting Extract All....
      • Open the extracted folder and double-click the .exe installer to run it.
        • If the Windows Defender SmartScreen warning appears, click on More Info.
        • Click Run Anyway.
      • Follow the setup wizard prompts. Click Close once the installation is complete.
      • Shortcuts for EmotiBit Oscilloscope, EmotiBit DataParser, and EmotiBit FirmwareInstaller will be created in your Start Menu .
      • Note: The installation process may be blocked by active anti-virus software. If you encounter issues, verify your anti-virus settings permit third-party installations. You will also need to grant firewall permissions later to allow data streaming over your Wi-Fi network.
    • Installation Instructions For Mac Users
      • Download EmotiBitSoftware-macOS.zip from the release page.
      • Move the downloaded zip file to your preferred directory. Double-click the .zip file to extract it.
      • The applications are located directly inside the extracted folder.
    • Installation Instructions For Linux Users
      • Follow the dedicated installation instructions provided directly on the GitHub release page.

2. Install Drivers

Important

You will install the firmware on the Feather module in the following sections using the USB cable. For the computer to be able to recognize the Feather when you plug it in, you MUST install the drivers mentioned in this section.

  • 2.1 OS-Specific Driver Installation:

    • On Windows 10
      • Ensure you have extracted EmotiBitSoftware-Windows.zip.
      • Navigate to EmotiBitSoftware-Windows > CP210x_Windows_Drivers.
      • Double-click to execute CP210xVCPInstaller_x64.exe.
      • Follow the on-screen instructions to complete the driver installation.
    • On Windows 11
      • Ensure you have extracted EmotiBitSoftware-Windows.zip (Right-click > Extract All...).
      • Navigate to EmotiBitSoftware-Windows > CP210x_Universal_Windows_Driver.
      • Right-click on silabser.inf (Setup Information file) and select Show more options > Install. (Note: If the install option is missing, verify the zip file was fully extracted).
      • Grant any requested administrative or firewall permissions required by your system configurations.
      • Once the process completes, the required drivers are installed.
    • On macOS
      • Ensure you have extracted EmotiBitSoftware-macOS.zip.
      • Navigate to the EmotiBitSoftware-macOS folder.
      • Double-click SiLabsUSBDriverDisk.dmg to mount the disk image in Finder.
      • Double-click Install CP210x VCP driver to launch the installer.
      • Follow the on-screen prompts to complete the installation.

Note

On macOS, if you experience the installer is stuck, make sure to check the System Settings > Privacy and Security section (Scroll to the end). There may be a prompt that needs your approval for the installer to proceed.

3. Prepare the SD Card

3.1 Adding WiFi credentials

Important

EmotiBit requires a local Wi-Fi network to initialize and establish communication with the EmotiBit Oscilloscope application. You must add valid network credentials to the microSD card configuration file before using emotibit. See the following FAQs for more details.

  • 3.1.1 Standard Configuration Procedure:

  1. Insert the microSD card into the provided reader and connect it to your computer.
  2. Download the default configuration file from emotibit.com/files/config.
  3. Open the downloaded configuration file using a standard text editor (e.g., Notepad on Windows or TextEdit on macOS).
  4. Locate the placeholder entries and replace YOUR_WIFI_NAME_GOES_HERE with your exact Wi-Fi network SSID and YOUR_WIFI_PASSWORD_GOES_HERE with your network password.
  5. Save the file onto your microSD card. Then safely eject the card from your computer.

Note

- EmotiBit only supports the 2.4GHz band for WiFi

Both the host computer and the EmotiBit need to be on the same 2.4GHz network. Initial experimental support for enterprise networks (that require a login/password after connecting) is available only for ESP32 Feathers. The EmotiBit codebase uses several Arduino libraries to unlock different features, for example, establishing and maintaining a WiFi connection. The limitations around the support for enterprise wifi, for example, lack of support for Feather M0, are therefore dictated by these libraries and lie outside the scope of the emotibit ecosystem.

  • 3.1.2 Multiple WiFi credentials
    • If you use multiple WiFi networks and want your EmotiBit to automatically connect to whichever one is in range, simply add both networks to the WifiCredentials array in the config file like this:
    {
  "WifiCredentials": [
    {
      "ssid": "wifi_1",
      "password": "password1"
    },
    {
      "ssid": "wifi_2",
      "password": "password2"
    },
    {
      "ssid": "wifi_3",
      "password": "password3"
    },
    {
      "ssid": "wifi_4",
      "password": "password4"
    }
  ]
}
  • 3.1.3 Adding Enterprise WiFi credentials (Advanced)
    • Enterprise WiFi network details are added to the config.txt file in the following format.
      • If no username is provided, userid will be used as username
      {
    "ssid": "enterprise-1",
    "userid": "user1",
    "username": "user1_name", 
    "password": "prize1"
  }
    • A sample config.txt file could look like
    {
"WifiCredentials": [
  {
    "ssid": "personal-1",
    "password": "pass1"
  },
  {
    "ssid": "enterprise-1",
    "userid": "user1_id",
    "username": "user1_name",
    "password": "prize1"
  }
]
}
    • Notes:
      • ESP32 takes a substantially long time to connect to an enterprise network (>10 secs as per our limited testing).
      • Since the ESP core is still under heavy development, there are some unexplained behaviors with enterprise connectivity. Through our testing, we discovered that using a software restart command before trying to connect to the enterprise network helps with connectivity. Therefore, if an enterprise network credential is added to the config file, the defined behavior is for the ESP to restart if a network connection is not made within a set timeout.
      • Unlike personal networks, enterprise networks can allocate devices on different subnets. For example, if your computer is on 192.168.100.150, your EmotiBit may be allocated an IP 192.168.101.68. Notice that they are on different subnets (100 and 101). For finer control over the subnets the Oscilloscope considers for device discovery, you can use the includeList section in the emotibitCommSettings.json file. You can find more information on that file in this FAQ. By default, all subnets are a part of the includeList.
  • 3.1.4 Adding credentials using Serial (Advanced)

    • The EmotiBit firmware also provides a provision to enter WiFi credentials through serial interface. To use this provision, you will need to download and install Arduino IDE. You will also need to upload the EmotiBit firmware to the device. Stack your EmotiBit and check out the section to learn how to use the EmotiBit Firmware Installer. Once you have installed the firmware and ArduinoIDE, proceed to the next steps.

    • Open Arduino IDE. Under Tools > Port notice the ports available, if any.

    • Make sure you have a stacked EmtotiBit and connect the Feather to the computer using the provided USB cable.

    • Once connected, check Tools > Port again in Arduino IDE. A new port will have appeared. Select that port.

    • Click on Tools > Serial Monitor to open a Serial Monitor on that port. A Serial Monitor should open, but may not output anything if EmotiBit is past setup. Make sure No line Ending and 2000000 baud is selected as the settings at the bottom.

    • Close the Serial Monitor. Reset the EmotiBit (by pressing the reset button) and open the Serial Monitor immediately after.

    • You will see setup messages being displayed. In setup, the EmotiBit waits for a few seconds to accept an input.

    • Type capital C in the input field. Wait for the Serial Monitor to print the message shown below and press Send / hit enter to send the character.

    • If your timing is right, you will see the following response in the Serial Monitor. You are now in WiFi credential edit mode.

    • If the EmotiBit continues setup, then you need to reset the EmotiBit, close and reopen the Serial Monitor and try and get the timing right so that the firmware registers the serial input.

    • Once in the WiFi credential edit mode, you can Add, Delete or View credentials in the config.txt file.

    • Adding a Credential

      • To add a credential, you will need to use the keyword WA.
      • In the Serial Monitor input type @WA,{"ssid":"SSSS","password" : "PPPP"}~
      • Replace SSSS with the network name and PPPP with the network password.
      • Once the Name and password are updated, hit Send.
      • You should see the following response on the Serial Monitor.

    • View existing credentials

      • To view existing credentials, you will need to use the keyword LS.
      • In the Serial Monitor input type @LS~. Hit Send.
      • The existing credentials, along with their passwords will be printed as a list.

    • Delete a credential

      • To delete existing credentials, you will need to use the keyword WD.
      • Use the LS keyword as mentioned above to get the list of existing credentials.
      • Note the number of the credential you want to delete.
      • In the Serial Monitor input type @WD,<network_number>~. Replace network number with a number on the list output in the previous step. For example, @WD,1~. Hit Send.
      • The credential will be deleted, and you will see the following output.

    • Reset

      • Once you have completed the edits to the credentials, type @RS~ in the Serial Monitor input. Hit Send.
      • The EmotiBit will restart and you will see Setup messages being printed on the Serial Monitor again.

4. Stack your EmotiBit!

4.1 Pre-Assembly Configuration

  1. Insert the SD card into the EmotiBit.
  2. Make sure the sliding switch (Hibernate switch) is set to the active (not HIB) position as shown (Available on only EmotiBit version V4+. The version is listed on the unique EmotiBit serial number attached to the back of EmotiBit.).

Important

If the HIB switch is left in the HIB position, the device programming will fail in the next steps!

Caution

- Excessive force can break the HIB switch. Handle with care!

4.2 Stacking the Boards

  1. Align the female header pins of the EmotiBit board with the male headers on the Adafruit Feather.
  2. Gently press the boards together until the pins are fully seated.
  3. Ensure the connector is firmly pushed all the way into the Feather connector

Important

At this point, the following checklist must be complete

  • EmotiBit has the configured sd card inserted
  • The HIB switch is not on "HIB"
  • The battery is inserted into the Feather
  • The EmotiBit and Feather have a secure fit



Understanding the LEDs and buttons on EmotiBit and the Feather

Note

This image is for reference only. Status LEDs illuminate independently and at different stages during normal operation.













5. Installing EmotiBit firmware

Important

Mandatory Action Required
To start using your EmotiBit, you must first install the latest EmotiBit firmware onto the Feather. Because EmotiBit devices ship completely blank without any pre-installed firmware, the hardware will not function until this installation step is completed.

Important

If you did not order an Essentials Kit or an All-In-One bundle, you will need a compatible Feather to get starter. You can grab Feather ESP32 Huzzah! or the Feather M0 WiFi from the Adafruit online store.

Important

Prerequisites Install required drivers, as explained in the section above.

5.1 Run EmotiBit Firmware Installer

  • Open the EmotiBit FirmwareInstaller (downloaded as a part of the software bundle above).
  • After you start the application, follow the on-screen instructions to complete installing the firmware.

Tip

If your firmware installation fails, confirm the following 3 are as expected

  1. The ESP32 Drivers are installed as described in the section above.
  2. Ensure you are using a data-capable USB cable. Charge-only cables will cause detection failures. The cable included in the EmotiBit bundles is tested to be data-capable.
  3. Confirm that the HIB switch on the EmotiBit board is set to 'On' (not in HIB).



  • Installing custom firmware (Advanced)
    • The EmotiBit FirmwareInstaller installs the stock firmware provided in the software bundle.
    • If you wish to install a custom firmware or an older firmware release, you can do so using the "Load" provision in the Firmware Installer.
    • To do so,
      • Press L on the first screen on the Firmware Installer (You may also notice that the Firmware Installer has a footnote with the same prompt.)
      • Choose the file (.bin) you want to install on EmotiBit
      • After selecting the file, you will return to the original Firmware Installer screen
      • Continue with the normal installation process (instructions on the screen)
    • For example, you may grab an earlier release from the EmotiBit firmware release page and install that firmware using the Load function in the EmotiBit Installer.
    • Alternatively, you can write your own custom firmware and create a binary. You can then use the Firmware Installer to install that binary.
    • WARNING: Make sure that the firmware you are trying to install has been written for the correct board version. Installing incompatible firmware may lead to unexpected behavior, or worse, may brick your device.

  • Linux and Advanced Users

    • EmotiBit software, including the EmotiBit FirmwareInstaller is not available as a distributed application for Linux. The following details the use of command-line tools users can use to program their Feathers.

      • Installing Emotibit Firmware on Feather M0 WiFi
        • Note: on macOS, you will need to give the EmotiBit FirmwareInatller application permissions to run the contained executables. To do so, right click on the EmotiBit FirmwareInstaller app and click on Open. This will open the application but you may close it to proceed below.
        • The FirmwareInstaller essentailly performs 3 actions:
          1. Uploads the firmware updater sketch to prep the Feather for WINC updater
          2. Updates the WINC WiFi module FW to version 19.6.1
          3. Uploads the latest EmotiBit FW onto the Feather, after the WINC has been updated
        • We use the bossac command line tool to upload binary files to the feather.
        • There are 2 requirements to run bossac
          • COM port on which the Feather is detected
          • The bin file (provided in the software release). If your flavor of Linux doesn't work with the provided bin file, you'll have to download/compile bossac yourself, but WARNING: THAR BE DRAGONS
            • Check out these instructions on installing bossac. PLEASE NOTE that with bossac version 1.9 or later, you must give an --offset parameter on the command line to specify where to start writing the firmware in flash memory. FAILING TO DO SO WILL BRICK YOUR FEATHER!
        • To perform the operations manually, follow the listed steps below:
          • Navigate to the data folder located inside the EmotiBit software directory.
            • On Linux the path to the data folder should look like EmotiBitSoftware-linux/ofxEmotiBit/EmotiBitFirmwareInstaller/bin/data
            • On macOS the path should look like EmotiBitSoftware-macOS/EmotiBitFirmwareInstaller.app/Contents/Resources
            • On Windows the path will be C:\Program Files\EmotiBit\EmotiBit FirmwareInstaller\data
          • Open a cmd prompt window for Windows or terminal for Linux/Mac at this location
          • Connect the Feather to the computer using a data-capable USB cable
            • The Feather should NOT be stacked with EmotiBit (to enable the programmer mode LED)
          • Double-press the reset button to set the Feather in programmer mode.
            • You should see the RED LED on the Feather pulsating!
              • [ToDo: add gif]
          • WARNING: DO NOT UNPLUG OR RESET FEATHER WHILE UPLOAD/UPDATE IS IN PROGRESS. YOU COULD BRICK YOUR FEATHER!
          • Upload the firmware updater sketch by running the following command (use .\bossac.exe for Windows, use ./bossac for macOS)
            • ./bossac_linux -i -d --port=YOUR_FEATHER_COM_PORT -U true -i -e -w -v ./WINC/FirmwareUpdater.ino.feather_m0.bin -R
              • [For Linux] If you get a permission denied error, run the command chmod u+x ./bossac_linux, to make the file executable.
          • Update the WINC by running (use .\FirmwareUploader.exe for Windows, use ./FirmwareUploader for macOS)
            • ./WINC/FirmwareUploader_linux -port YOUR_FEATHER_COM_PORT -firmware ./WINC/m2m_aio_3a0.bin
              • [For Linux] If you get a permission denied error, run the command chmod u+x ./WINC/FirmwareUploader_linux , to make the file executable.
          • ONLY AFTER the FirmwareUploader command completes, double-press the reset button to set the Feather in programmer mode again
          • Upload the EmotiBit FW using (use .\bossac.exe for Windows, use ./bossac for macOS)
            • ./bossac_linux -i -d --port=YOUR_FEATHER_COM_PORT -U true -i -e -w -v EmotiBit_stock_firmware.ino.feather_m0.bin -R
      • Installing Emotibit Firmware on Feather ESP32 Huzzah
        • Note: on macOS, you will need to give the EmotiBit FirmwareInatller application permissions to run the contained executables. To do so, right click on the EmotiBit FirmwareInstaller app and click on Open. This will open the application but you may close it to proceed below.
        • The FirmwareInstaller essentailly uploads the latest EmotiBit FW onto the Feather
        • We use the esptool command line tool to upload binary files to the feather.
        • There are 2 requirements to run esptool
          • COM port on which the Feather is detected
          • The esptool bin file (provided in the software release).
        • To perform the operations manually, follow the listed steps below:
          • Navigate to the data folder located inside the EmotiBit software directory.
            • On Linux the path to the data folder should look like EmotiBitSoftware-linux/ofxEmotiBit/EmotiBitFirmwareInstaller/bin/data
            • On macOS the path should look like EmotiBitSoftware-macOS/EmotiBitFirmwareInstaller.app/Contents/Resources
            • On Windows the path will be C:\Program Files\EmotiBit\EmotiBit FirmwareInstaller\data
          • Open a cmd prompt window for Windows or terminal for Linux/Mac at this location
          • Connect the Feather to the computer using a data-capable USB cable.
            • The Feather should show up as a COM port on the system.
              • On Windows: The device appears with a name similar to COM X (where X is a number)
              • On Mac/Linux: You may find the COM port by running the terminal command ls -la /dev/tty*
              • Pro-tip for Linux: the Feather may likely show up as /dev/ttyUSB0
          • WARNING: DO NOT UNPLUG OR RESET FEATHER WHILE UPLOAD/UPDATE IS IN PROGRESS. YOU COULD BRICK YOUR FEATHER!
          • replace YOUR_FEATHER_PORT with the COM port you detected in the previous step in the following command and run it to upload the firmware.
            • ./exec/linux/esptool --chip esp32 --port YOUR_FEATHER_PORT --baud 921600 --before default_reset --after hard_reset write_flash -z --flash_mode dio --flash_freq 80m --flash_size 4MB 0x1000 ./esp32/EmotiBit_stock_firmware.ino.bootloader.bin 0x8000 ./esp32/EmotiBit_stock_firmware.partitions.bin 0xe000 ./esp32/boot_app0.bin 0x10000 ./EmotiBit_stock_firmware.ino.feather_esp32.bin
              • [For Linux] If you get a permission denied error, run the command chmod u+x ./exec/esptool, to make the file executable.
              • [For Windows] replace ./exec/linux/esptool with .\exec\win\esptool.exe. You will also need to change all file paths to .\esp32\name-of-file
              • [For macOS] replace ./exec/linux/esptool with ./exec/mac/esptool.

EmotiBit Bootup

Important

The EmotiBit bootup sequence can only be followed IF the firmware was successfully installed in the previous step.

When EmotiBit is booting up, the LEDs are used to indicate the steps in the process. EmotiBit BLUE LED BLINKING indicates the EmotiBit was setup succesfully and the EmotiBit is connected to the WiFi. If EmotiBit gets stuck prior to connecting to your WiFi, you can use the table below to assess what went wrong and how to fix it. The following section depicts the sequence of setup operations.

[ Boot Up ]
      │
-     ├──► ( Feather RED LED ON ) ────────────────────────────────────────► [ STUCK HERE ] ──► Post on Forum
      │
-     └──► ( Feather RED LED ON for seconds ──► OFF ) ────────────────────► [ STUCK HERE ] ──► Check SD Card Insertion
                │
-               └──► ( EmotiBit RED LED ON ) ─────────────────────────────► [ STUCK HERE ] ──► Check Config File Format
                          │
-                         └──► ( EmotiBit BLUE LED solid ON ) ────────────► [ STUCK HERE ] ──► Verify WiFi Credentials
                                    │
+                                   └──► ( EmotiBit BLUE LED BLINKING ) ──► [ SUCCESS: Connected! ]
Stuck LED State LED Indicator What to do?
Feather RED LED ON Write a post describing your steps on http://forum.emotibit.com/
Feather RED LED turns ON for a few seconds and then stays OFF Check if SD card is correctly inserted
EmotiBit RED LED ON Check if config file is present on the SD card
AND
config file is formatted correctly (A missing " or missing bracket {},[] can cause a parsing failure.)
EmotiBit BLUE LED solid ON Verify correct WiFi credentials in config file (see Adding WiFi credentials)
EmotiBit BLUE LED BLINKING Huzzah! EmotiBit is connected to your WiFi! Open EmotiBit Oscilloscope to start streaming biometric data!

Next Steps: Connecting to EmotiBit and Streaming EmotiBit Data

  • The EmotiBit Oscilloscope communicates with the EmotiBit device over a WiFi network connection. For this communication to function, the Oscilloscope requires permission from your computer's operating system to access and use the local network.
  • The very first time you launch the EmotiBit Oscilloscope on your computer, your operating system (Windows or macOS) will prompt you to grant network access permissions to the application.

Important

Action Required: You must grant the appropriate network permissions when prompted.
Without these explicit permissions, the EmotiBit Oscilloscope cannot detect or communicate with the EmotiBit connected to your network. Data streaming will fail. The sections that follow provide a visual guide on how to navigate the permissions screen for your specific operating system.

Permissions on Windows

  • When you open the EmotiBit Oscilloscope, the following pop-up will be displayed on your screen.

  • Windows Security Alert pop-up (Windows Defender Firewall)
    • When the Windows Security Alert pop-up appears, allow private network access. You must also allow access on public networks if you plan to use the EmotiBit on a public network. If you have an Antivirus program installed, make sure the appropriate settings are enabled to grant the EmotiBit Oscilloscope network access.

  • You can update the Windows Defender Firewall settings at any time.

    • Update Windows Defender permissions (Windows Defender Firewall)
      • Open the Setting that shows up on the Start menu.
      • Make sure both Public and Private are selected for emotibitoscilloscope.

Permissions on macOS

  • Opening Software in mscOS Catalina and newer
    • Right-click on the application you want to run. Choose Open.
    • A dialog box will appear with options Move to Trash or Cancel. Click Cancel. You will have to allow the application to run in the Security and Privacy center. To do so:
    • Click on the Apple Logo > System Preferences > Security and Privacy.
    • You will find a request from the application at the bottom of this window. Click on Open Anyways.
    • Click on Allow on the dialog box that appears. This will open the application.

Tip

Check out the following FAQs if you cannot stream EmotiBit data to the EmotiBit Oscilloscope

After connecting to emotibit and streaming data

By this point, you're ready to be an EmotiBit rockstar!! Check out the following links to learn more about EmotiBit!

Troubleshooting

  • To troubleshoot any Getting Started issues, check out this troubleshooting guide. It lists all possible issues you may face while getting the EmotiBit setup and also offers suggestions on how to solve that issue.
  • Checkout the EmotiBit FAQ.
  • FAQs did not help out? Post on the EmotiBit Forum