Skip to main content

Instinct SDK Overview

The Nexstem Instinct SDKs provide developers with powerful tools to build applications that interact with Instinct headsets. These SDKs abstract the complexity of low-level device communication, allowing you to focus on creating innovative brain-computer interface applications.

Available SDKs​

Nexstem provides SDKs for multiple programming languages to accommodate different development environments and use cases:

Core Capabilities​

All Instinct SDKs share a common set of core capabilities:

1. Device Discovery and Connection​

Easily discover Instinct headsets on your local network or connect directly using IP addresses:

// JavaScript
const headsets = await Headset.discover();
# Python
headsets = Headset.discover()

2. Headset State Monitoring​

Monitor real-time headset metrics including battery levels, CPU usage, and connection status:

// JavaScript
const state = await headset.getState();
console.log(`Battery: ${state.battery.percent}%`);
# Python
state = headset.get_state()
print(f"Battery: {state.battery.percent}%")

3. Data Stream Management​

Create and manage complex data processing pipelines for EEG signal analysis:

// JavaScript
const stream = headset.StreamsManager.createStream({
  // Stream configuration
});
await stream.create();
await stream.start();
# Python
stream = headset.streams_manager.create_stream({
  # Stream configuration
})
await stream.create()
await stream.start()

4. Electrode Configuration​

Configure and manage electrodes, including impedance checking:

# Python
impedance_results = await headset.electrode_manager.check_impedance(["Fp1", "Fp2"])

5. Device Configuration Management​

Store and retrieve persistent configuration values on the headset:

// JavaScript
await headset.DeviceConfigManager.createConfig({
  key: 'user_settings',
  value: { theme: 'dark' },
  expiresIn: '30d',
});
# Python
await headset.device_config_manager.create_config({
  "key": "user_settings",
  "value": { "theme": "dark" },
  "expires_in": "30d"
})

Getting Started​

To start using the Instinct SDKs, follow these steps:

  1. Choose your SDK - Select the SDK that best fits your development environment
  2. Install the package - Follow the installation instructions for your chosen SDK
  3. Connect to a headset - Discover headsets on your network or connect directly
  4. Create your first stream - Build a simple data processing pipeline
  5. Explore advanced features - Dive into the comprehensive reference documentation

Use Cases​

The Instinct SDKs enable a wide variety of applications:

  • Neurofeedback - Create real-time feedback loops based on brain activity
  • BCI Control Systems - Build brain-computer interfaces for device control
  • Cognitive Monitoring - Develop applications for attention, focus, or stress monitoring
  • Research - Design custom protocols for neuroscience research
  • Biometric Applications - Integrate EEG data with other biometric signals

Choosing Between SDKs​

  • JavaScript SDK: Ideal for web-adjacent applications, Node.js backends, or integration with web technologies
  • Python SDK: Perfect for data science applications, machine learning integration, or academic research

Each SDK reference includes comprehensive documentation, code examples, and best practices to help you build powerful applications with the Instinct platform.

Next Steps​