Skip to content

Add guide for new io formats #548

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

Merged
merged 7 commits into from
Apr 18, 2019
Merged

Add guide for new io formats #548

merged 7 commits into from
Apr 18, 2019

Conversation

felixdivo
Copy link
Collaborator

@felixdivo felixdivo commented Apr 11, 2019

This adds a guide on how to add new file format support.

Added in response to #506.

@felixdivo felixdivo added the docs label Apr 11, 2019
@felixdivo felixdivo added this to the 3.2 Release milestone Apr 11, 2019
@felixdivo felixdivo self-assigned this Apr 11, 2019
@felixdivo felixdivo requested a review from hardbyte April 11, 2019 10:25
@felixdivo felixdivo changed the title Add guide for new io format Add guide for new io formats Apr 11, 2019
@danielhrisca
Copy link
Contributor

@felixdivo

each Writer is meant to handle a single bus channel? For example if we have a vector HW and we use bus channels 0 and 1 then the used should instantiate two Write objects for each of them?

@codecov
Copy link

codecov bot commented Apr 11, 2019

Codecov Report

Merging #548 into develop will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop     #548   +/-   ##
========================================
  Coverage    64.44%   64.44%           
========================================
  Files           63       63           
  Lines         5651     5651           
========================================
  Hits          3642     3642           
  Misses        2009     2009

@felixdivo
Copy link
Collaborator Author

Writers are just dumb can.Listeners, which receive messages in the on_message_received() method. The writer does not care about the bus that this message came from or how it was brought there, except maybe that the Message.channel attribute is set that then gets serialized. So there may be zero to many writers serializing the messages of zero to many buses. Distributing is often done by using a Notifier. Does that answer you question?

@danielhrisca
Copy link
Contributor

I got the point. I'll think about a strategy to handle this

Copy link
Owner

@hardbyte hardbyte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fantastic guide!

Please consider a few suggested changes.

@hardbyte hardbyte merged commit cfb5721 into develop Apr 18, 2019
@hardbyte hardbyte deleted the add-guide-for-new-io-format branch April 18, 2019 01:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants