facebookresearch/labgraph

Serial Port Support in LabGraph

Open

#42 opened on Jan 15, 2022

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Python (46 forks)auto 404
good first issue

Repository metrics

Stars
 (165 stars)
PR merge metrics
 (PR metrics pending)

Description

🚀 Feature

Sensor & Device integration is an important part to help accelerate researchers development. This integration on Serial Port will allow new devices to be automatically usable in LabGraph. Serial Port here refers to pyserial: https://pypi.org/project/pyserial/

Additional context

  1. Create relevant files using the example from https://github.com/facebookresearch/labgraph/tree/main/labgraph/zmq_node
  2. The code should be added at folder is https://github.com/facebookresearch/labgraph/tree/main/devices/protocols/
  3. Create setup.py and README.md, where example can be found at: https://github.com/facebookresearch/labgraph/tree/main/extensions/labgraph_viz
  4. Add github action support, reference: https://github.com/facebookresearch/labgraph/actions/workflows/main.yml

Contributor guide

Research direction
Inspect the existing zmq node example and the labgraph viz extension to replicate the structure for serial port support. Add necessary files in devices/protocols/ and create setup.py and README.md. Also add a GitHub Actions workflow based on main.yml.
Tech stack
python
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70