facebookresearch/labgraph

Network Sockets Support in LabGraph

Open

#41 opened on Jan 14, 2022

View on GitHubContributor guide
 (4 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 Network Sockets will allow new devices to be automatically usable in LabGraph. Network socket here refers to python socket module: https://docs.python.org/3/library/socket.html . A stretch goal is to also support Boost.Asio, https://www.boost.org/doc/libs/1_76_0/doc/html/boost_asio.html

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
  5. Add proper license header, example.

Contributor guide

Research direction
Study the existing zmq node structure and create a similar implementation for network sockets. Follow the folder structure under devices/protocols/, add setup.py and README.md as in labgraph viz, and include GitHub Actions workflow for CI. Ensure proper license headers.
Tech stack
python
Domain
backendinfrastructure
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 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.
Clear
Prerequisites
PythonBasic understanding of sockets
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75