Petal Docs
  • Introduction
  • Connect to muse (Free)
    • Connect muse & Stream Raw Data
      • Connect muse to Mac
      • Connect muse to Windows
  • Receive Data Streams (Free)
    • Receive an LSL Stream
      • Python Examples
      • Node Examples
    • Receive an OSC Stream
      • Python Examples
      • Node Examples
    • Receive Webhooks
      • Python Examples
      • Node Examples
  • Log Data (Free)
    • Logging Data
  • Metrics API (Maker Plan)
    • API Integration
    • Make Metrics API calls
      • Python Examples
      • Node.js Examples
  • Receive Data Streams (Maker Plan)
    • Receive an LSL Stream
      • Python Examples
      • Node Examples
    • Receive an OSC Stream
      • Python Examples
      • Node Examples
    • Receive Webhooks
      • Python Examples
      • Node Examples
  • Glossary of Terms
    • Glossary of Terms
  • 🧪Markers
    • 🧪Markers User Guide
Powered by GitBook
On this page
  • Receiving an OSC Stream (UDP)
  • API Stream Topics & Format

Was this helpful?

  1. Receive Data Streams (Maker Plan)

Receive an OSC Stream

PreviousNode ExamplesNextPython Examples

Last updated 2 years ago

Was this helpful?

Receiving an OSC Stream (UDP)

OSC, or Open Sound Protocol, is a protocol that provides typed fields for high frequency streams. It can be used to stream or ingest device EEG data. To receive an OSC stream, you can also use some of the example scripts in the .

In order to get around byte-based precision limitations of OSC data types, our data streams all have the following formatted prefix:

  • int: sample ID

  • int: unix timestamp (whole number)

  • float: unix timestamp (decimal)

  • int: LSL timestamp (whole number)

  • float: LSL timestamp (decimal)

API Stream Topics & Format

If the API is enabled, API-specific topics are:

Blink (topic: PetalStream/blink):

  • int: blink (0 = no blink, 1 = blink)

Eye Movement (topic: PetalStream/eye):

  • int: movement (1 = movement, 0 = no movement)

Bandpower (topic: PetalStream/bandpower):

  • float: channel1_alpha

  • float: channel1_beta

  • float: channel1_theta

  • float: channel1_delta

  • float: channel2_alpha

  • float: channel2_beta

  • float: channel2_theta

  • float: channel2_delta

  • float: channel3_alpha

  • float: channel3_beta

  • float: channel3_theta

  • float: channel3_delta

  • float: channel4_alpha

  • float: channel4_beta

  • float: channel4_theta

  • float: channel4_delta

Artifact Detection (topic: PetalStream/artifact_detect):

  • int: channel1 (1 = good, 0 = bad)

  • int: channel2 (1/0)

  • int: channel3 (1/0)

  • int: channel4 (1/0)

All Metrics: PetalStream_metrics

  • int: blink (0 = no blink, 1 = blink)

  • int: eye (0 = no movement, 1 = movement)

  • int: artifact_detect_channel1 (good = 1, bad = 0)

  • int: artifact_detect_channel2 (1/0)

  • int: artifact_detect_channel3 (1/0)

  • int: artifact_detect_channel4 (1/0)

  • float: channel1_alpha

  • float: channel1_beta

  • float: channel1_theta

  • float: channel1_delta

  • float: channel2_alpha

  • float: channel2_beta

  • float: channel2_theta

  • float: channel2_delta

  • float: channel3_alpha

  • float: channel3_beta

  • float: channel3_theta

  • float: channel3_delta

  • float: channel4_alpha

  • float: channel4_beta

  • float: channel4_theta

  • float: channel4_delta

getting started repo