brainflow-dev / brainflow-dev/brainflow

design the uniform standard for device configuration

Open
#552 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
C++
Stars
1.8k
Forks
414
Avg merge
9d 3h
Merged PRs (30d)
7

Description

Currently arguments for `config_board` method are device specific and determined by device manufactorer. For some devices we've added custom commands like: `board.config_board("sampling_rate:500")` but it's also not unified.

Need to take a look at all these commands and design uniform format for it in user API. Behind the scene these format will be converted to device-specific commands.

Types of commands we currently have:
* Muse boards preset commands (p50, p61,etc)
* OpenBCI Cyton (x12345678X)
* Ant Neuro (sampling_rate:500)

Contributor guide

Open the contributing guide

Research direction

Start by locating the config_board implementations and the existing Muse, OpenBCI Cyton, and Ant Neuro command handling. Compare their current argument formats and define a uniform user-facing format with device-specific conversion; done means all listed command types are covered consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
api, embedded-iot
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.