leducp / leducp/KickCAT

Improve Bus.cc API for diagnostic

Open
#109 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
170
Forks
39
PR merge metrics
No merged PRs in 30d

Description

When trying to use Bus.cc from the client side to investigate cable losses a few issues arise:

  • We can't call detectSlaves after init to count the number of slaves still connected on the network, because detectSlaves modify the slaves vector -> we should rework this function and split it in two to allow scanning for the slaves without modifying the bus object.

  • The api to send / get datagram on the bus should be split in two to allow client to choose what to send / receive and at which moment.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in Bus.cc by tracing detectSlaves, the slaves vector, and the existing datagram send/get API from their client-side callers. Separate slave scanning from bus-object mutation, and separate datagram selection from transmission and reception so the client controls when each occurs. Done means both diagnostic use cases work without unwanted bus state changes or coupled datagram operations.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
networking
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.