Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code quality improvements for v0.3.0+ #4

Open
10 of 21 tasks
mxk opened this issue Mar 27, 2023 · 0 comments
Open
10 of 21 tasks

Code quality improvements for v0.3.0+ #4

mxk opened this issue Mar 27, 2023 · 0 comments
Assignees

Comments

@mxk
Copy link
Owner

mxk commented Mar 27, 2023

General

  • Split README.md and crate documentation?
  • General documentation cleanup.
  • Simplify Error types and review the design.
  • Review logging structure and maybe switch to span-based logging in places.
  • Replace uses of std with core/alloc to start moving toward no_std support.
  • Remove unnecessary derives.
  • Restrict visibility for internal library components.

USB

  • Put usb backend behind a feature flag.
  • Do not expose rusb::Error.

HCI

  • Populate hci::Conn::local_addr when the connection is created. This requires hci::Host to track advertising state commands.
  • Block on hci::Error::CommandQuotaExceeded.
  • Store DisconnectionComplete reason.
  • Log informational events (e.g. ReadRemoteVersionInformationComplete, LePathLossThreshold).

L2CAP

  • Handle L2CAP Signal channel events.
  • Get rid of l2cap::Alloc and cache transfers in RawChan.

SMP

  • Send encryption request when the client first connects.
  • Handle SMP rate limiting and repeated pairing attempts.
  • Atomic file storage.
  • Review smp::{Display, Confirm} API.

HID

  • Review HID module design and simplify for the new API.
  • Use physical DPI units for the mouse.
@mxk mxk self-assigned this Mar 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant