#118 USB Device Emulation
Closed: scheduled 2 months ago by theevilskeleton. Opened 2 months ago by rlengland.

Nowadays, there are more and more devices and modern operating systems must try to support all types and several of them with every integration, with every release. Maintaining a large number of devices is difficult, expensive and also hard to test, specially for plug-and-play devices, like USB devices.


Metadata Update from @rlengland:
- Issue tagged with: article, needs-image

2 months ago

Metadata Update from @rlengland:
- Custom field editor adjusted to theevilskeleton

2 months ago

Metadata Update from @glb:
- Custom field preview-link adjusted to https://fedoramagazine.org/?p=36424&preview=true
- Custom field publish adjusted to 2022-05-06

2 months ago

Metadata Update from @jtornosm:
- Issue assigned to jtornosm

2 months ago

This is a really interesting article, and I have enjoyed reading it! I have some critique regarding the structure and clarity of the article.

I capitalized all instances of "B" in "bluetooth".
I also lower cased headings, except acronyms and the first letter of each heading.

I feel like the title should be a bit more specific. Like, the title should convey or hint what the article is about. It's like writing an article about Flatpak with the title that is literally "Flatpak". It doesn't look interesting if the title is only "USB Device Emulation", in my opinion.

USB/IP project (http://usbip.sourceforge.net/)

I suggest making it a hyperlink. It should look like "USB/IP project".

USB/IP project (http://usbip.sourceforge.net/) allows sharing the USB devices connected to a local machine so that it can be managed by another machine connected to the network by means of a TCP/IP connection.

What is "it"?

Then USB/IP project consist of two parts:

I presume you meant to write "The USB/IP project consists of two parts:"?

remotize [...] remotization

What does this mean exactly? Is it an actual definition? I checked online and I couldn't really find a proper meaning. If there is indeed a meaning, I suggest explaining what it is, perhaps even a separate paragraph could be helpful.

Local support has a very similar structure but as I have mentioned, as our goal is the device emulation we will do not talk about this.

I suggest writing something like "Local support has a very similar structure, this is out of scope of this article."

The commented options and kernel modules are already included in some Linux distributions like Fedora.

I changed it to "Fedora Linux".

Some distributions like Fedora Linux provide the usbip package with this tool.

"provide" as in pre-installed with the distribution or available in the repository? I recommend clarifying it.

Suitable rpm package can also be generated from the usbip-emulator repo https://github.com/jtornosm/USBIP-Virtual-USB-Device.git:

I changed "repo" to "repository", and I recommend hyperlinking to "usbip-emulator repository".

python and c

I capitalized the P in "python" and C in every occasion.

(as we saw previously, for this example machine, bus 3 is virtualized)

I capitalized the first "a".

(“1-1” is the pair bus-port for usb on the local machine, as we are emulating, it could be anything. It is only important because usbip tool will have to use the same name to request the emulated device)

I believe "USB" should be capitalized. I'm not sure if you are talking about an output or the acronym.

(as we saw previously, for this example machine, bus 3 is virtualized)

I capitalized the first "a" again.

(ip forwarding is disabled in both sides)

I capitalized "ip".

Second, for example, from other directly ethernet connected machine (real or virtual) we can configure a macvlan interface in the same subnet to send/receive traffic (ping, iperf, …):

I capitalized to "Ethernet". I also capitalize other proper nouns

Hey @theevilskeleton: Is the cover image the right dimensions? At a glance, it doesn't look quite right.

Also, are the "preformatted" sections set to the right block type? I just noticed that they look a little off.

First of all, thank you very much for reviewing!

This is a really interesting article, and I have enjoyed reading it! I have some critique regarding the structure and clarity of the article.

Thanks!

I capitalized all instances of "B" in "bluetooth".
I also lower cased headings, except acronyms and the first letter of each heading.

Ok

I feel like the title should be a bit more specific. Like, the title should convey or hint what the article is about. It's like writing an article about Flatpak with the title that is literally "Flatpak". It doesn't look interesting if the title is only "USB Device Emulation", in my opinion.

You are right, perhaps it is a git generic. But I would like to keep "USB Device Emulation" in the title because that it is what I am really doing and the current software it is only a proof of concept. So, what do you think if I complete it like this?
"USB Device Emulaiton and how to take advantage of it"

USB/IP project (http://usbip.sourceforge.net/)

I suggest making it a hyperlink. It should look like "USB/IP project".

Perfect

USB/IP project (http://usbip.sourceforge.net/) allows sharing the USB devices connected to a local machine so that it can be managed by another machine connected to the network by means of a TCP/IP connection.

What is "it"?

You are right, it should be "they" because I am talking about USB devices

Then USB/IP project consist of two parts:

I presume you meant to write "The USB/IP project consists of two parts:"?

Yes, you are right

remotize [...] remotization

What does this mean exactly? Is it an actual definition? I checked online and I couldn't really find a proper meaning. If there is indeed a meaning, I suggest explaining what it is, perhaps even a separate paragraph could be helpful.

Perhaps it is a similar word to other one that technical people use in Spanish "remotizar".
Ok, if it is ok, we can change for "get remote control"

Local support has a very similar structure but as I have mentioned, as our goal is the device emulation we will do not talk about this.

I suggest writing something like "Local support has a very similar structure, this is out of scope of this article."

What about this?
"Local support has a very similar structure, but as I have mentioned, as our goal is the device emulation, this is out of scope of this article."
I think it is important to tell why I am not explainning that.

The commented options and kernel modules are already included in some Linux distributions like Fedora.

I changed it to "Fedora Linux".

Perfect

Some distributions like Fedora Linux provide the usbip package with this tool.

"provide" as in pre-installed with the distribution or available in the repository? I recommend clarifying it.

Ok
What about this?
"Some distributions like Fedora Linux provide as available the usbip package with this tool."

Suitable rpm package can also be generated from the usbip-emulator repo https://github.com/jtornosm/USBIP-Virtual-USB-Device.git:

I changed "repo" to "repository", and I recommend hyperlinking to "usbip-emulator repository".

Perfect

python and c

I capitalized the P in "python" and C in every occasion.

Ok

(as we saw previously, for this example machine, bus 3 is virtualized)

I capitalized the first "a".

Ok

(“1-1” is the pair bus-port for usb on the local machine, as we are emulating, it could be anything. It is only important because usbip tool will have to use the same name to request the emulated device)

I believe "USB" should be capitalized. I'm not sure if you are talking about an output or the acronym.

Ok, I think it would be even better "USB device"

(as we saw previously, for this example machine, bus 3 is virtualized)

I capitalized the first "a" again.

Ok

(ip forwarding is disabled in both sides)

I capitalized "ip".

Ok

Second, for example, from other directly ethernet connected machine (real or virtual) we can configure a macvlan interface in the same subnet to send/receive traffic (ping, iperf, …):

I capitalized to "Ethernet". I also capitalize other proper nouns

Ok

Hey @theevilskeleton: Is the cover image the right dimensions? At a glance, it doesn't look quite right.

@glb nice catch. It's actually not. I'm going to create an image after we come up with a title.

I feel like the title should be a bit more specific. Like, the title should convey or hint what the article is about. It's like writing an article about Flatpak with the title that is literally "Flatpak". It doesn't look interesting if the title is only "USB Device Emulation", in my opinion.

You are right, perhaps it is a git generic. But I would like to keep "USB Device Emulation" in the title because that it is what I am really doing and the current software it is only a proof of concept. So, what do you think if I complete it like this?
"USB Device Emulaiton and how to take advantage of it"

I think this shares the same problem, but it's definitely better. As an example, I could write an article with the title "Dogs and how to feed them", when it could be "How to feed dogs".

What are your thoughts on "How to take advantage of USB Device Emulation"? Or "An introduction to USB Device Emulation"?

What does this mean exactly? Is it an actual definition? I checked online and I couldn't really find a proper meaning. If there is indeed a meaning, I suggest explaining what it is, perhaps even a separate paragraph could be helpful.

Perhaps it is a similar word to other one that technical people use in Spanish "remotizar".
Ok, if it is ok, we can change for "get remote control"

I think this one is better and clearer.

Local support has a very similar structure but as I have mentioned, as our goal is the device emulation we will do not talk about this.

I suggest writing something like "Local support has a very similar structure, this is out of scope of this article."

What about this?
"Local support has a very similar structure, but as I have mentioned, as our goal is the device emulation, this is out of scope of this article."
I think it is important to tell why I am not explainning that.

I agree with you, but I also feel like the sentence is too long. Perhaps we could change the sentence a bit? It could look like "Local support has a very similar structure, but as our goal is to discuss about device emulation, this is out of scope of this article."

"provide" as in pre-installed with the distribution or available in the repository? I recommend clarifying it.

Ok
What about this?
"Some distributions like Fedora Linux provide as available the usbip package with this tool."

Hmm... I still have trouble reading that.

If "provided" means to have usbip already pre-installed, then it could be "Some distributions like Fedora Linux pre-install the usbip utility."

If "provided" means to be available in the distribution repository, then it could be "Some distributions like Fedora Linux have the usbip utility available in the repositories. You can install the usbip package."

Of course, it's just a draft. We can improve it if you want, or keep what it was.

Also, are the "preformatted" sections set to the right block type? I just noticed that they look a little off.

Yeah, it was a table. I changed it to preformatted.

Local support has a very similar structure, but as our goal is to discuss about device emulation, this is out of scope of this article.

I have another suggestion. How about the following?

Local support has a very similar structure, but the focus of this article is device emulation.

Sorry for the late reply. I prefer that.

I have modified the article with some of your first comments:

USB/IP project (http://usbip.sourceforge.net/)

I suggest making it a hyperlink. It should look like "USB/IP project".

Perfect

Done

USB/IP project (http://usbip.sourceforge.net/) allows sharing the USB devices connected to a local machine so that it can be managed by another machine connected to the network by means of a TCP/IP connection.

What is "it"?

You are right, it should be "they" because I am talking about USB devices

Done

Then USB/IP project consist of two parts:

I presume you meant to write "The USB/IP project consists of two parts:"?

Yes, you are right

Done

remotize [...] remotization

What does this mean exactly? Is it an actual definition? I checked online and I couldn't really find a proper meaning. If there is indeed a meaning, I suggest explaining what it is, perhaps even a separate paragraph could be helpful.

Perhaps it is a similar word to other one that technical people use in Spanish "remotizar".
Ok, if it is ok, we can change for "get remote control"

Done. I have replace "remotiz..." with something meaning remote access .

... and I recommend hyperlinking to "usbip-emulator repository".

Perfect

Done

(“1-1” is the pair bus-port for usb on the local machine, as we are emulating, it could be anything. It is only important because usbip tool will have to use the same name to request the emulated device)

I believe "USB" should be capitalized. I'm not sure if you are talking about an output or the acronym.

Ok, I think it would be even better "the USB device"

Done

I continue with the new comments, except that one related to remotiz ... that was previously commented (and fixed if it is ok for you).

I feel like the title should be a bit more specific. Like, the title should convey or hint what the article is about. It's like writing an article about Flatpak with the title that is literally "Flatpak". It doesn't look interesting if the title is only "USB Device Emulation", in my opinion.

You are right, perhaps it is a git generic. But I would like to keep "USB Device Emulation" in the title because that it is what I am really doing and the current software it is only a proof of concept. So, what do you think if I complete it like this?
"USB Device Emulaiton and how to take advantage of it"

I think this shares the same problem, but it's definitely better. As an example, I could write an article with the title "Dogs and how to feed them", when it could be "How to feed dogs".

What are your thoughts on "How to take advantage of USB Device Emulation"? Or "An introduction to USB Device Emulation"?

This is the most complicated and the most important issue for me.
I appreciate a lot your intention to improve the title because it was too generic.
And if it is possible I would like something to include both concepts about your suggestions.
Perhaps, "An introduction to USB Device Emulation and how to take advantage of it", I do not know if it s too long ...
Although it would be the same than the dog food, I don't mean just food, that's why I would like to keep the previous part.
In fact, the new word introduction is also very important and can be useful because the blog is an idea that I would like to improve with a better software and if it is ok in later blogs.
Is it better in this way?
I have also modified the title but only to include the current status in the draft.

Local support has a very similar structure but as I have mentioned, as our goal is the device emulation we will do not talk about this.

I suggest writing something like "Local support has a very similar structure, this is out of scope of this article."

What about this?
"Local support has a very similar structure, but as I have mentioned, as our goal is the device emulation, this is out of scope of this article."
I think it is important to tell why I am not explainning that.

I agree with you, but I also feel like the sentence is too long. Perhaps we could change the sentence a bit? It could look like "Local support has a very similar structure, but as our goal is to discuss about device emulation, this is out of scope of this article."

I have another suggestion. How about the following?

Local support has a very similar structure, but the focus of this article is device emulation.

I also prefer that.
I have replaced the sentence with your suggestion.

"provide" as in pre-installed with the distribution or available in the repository? I recommend clarifying it.

Ok
What about this?
"Some distributions like Fedora Linux provide as available the usbip package with this tool."

Hmm... I still have trouble reading that.

If "provided" means to have usbip already pre-installed, then it could be "Some distributions like Fedora Linux pre-install the usbip utility."

If "provided" means to be available in the distribution repository, then it could be "Some distributions like Fedora Linux have the usbip utility available in the repositories. You can install the usbip package."

Of course, it's just a draft. We can improve it if you want, or keep what it was.

If it is not clear, I have to improve it.
Let me try to do in another way:
"In some distribution like Fedora Linux, the usbip utility can be installed by means of usbip package from repositories. If usbip utility or related package can not be found ..."
I have also modified this in the article but only to include the current status in the draft.

Thank you very much for helping me to improve my blog!

Perhaps, "An introduction to USB Device Emulation and how to take advantage of it", I do not know if it s too long ...
Although it would be the same than the dog food, I don't mean just food, that's why I would like to keep the previous part.
In fact, the new word introduction is also very important and can be useful because the blog is an idea that I would like to improve with a better software and if it is ok in later blogs.
Is it better in this way?
I have also modified the title but only to include the current status in the draft.

It is indeed longer than I'd like to be, but I think it's fine for this article because it already talks about a lot.

"In some distribution like Fedora Linux, the usbip utility can be installed by means of usbip package from repositories. If usbip utility or related package can not be found ..."
I have also modified this in the article but only to include the current status in the draft.

This is so much better. Now all there is to be done is to improve the featured image. We should add some text to it. Do you want to do it? You can read through the documentation in the Fedora Docs website: https://docs.fedoraproject.org/en-US/fedora-magazine/

If you don't feel comfortable, I can create the featured image.

Thank you very much for helping me to improve my blog!

No problem!

Then the blog is almost finished, great!

If it s possible, I would like to use the image that is currently selected, because it is the real photo of the USB devices that I can emulate.
Let me try to improve the featured image, or at least convert to SVG (if I can)

Are you referring to a new text for the photo? For example this
"A big bunch of USB devices"
Or are you referring to the article introduction text/meta desription?
Is not good/enough the one that is currently included? does it need to be longer?

Metadata Update from @jtornosm:
- Assignee reset
- Issue untagged with: article, needs-image

2 months ago

Metadata Update from @jtornosm:
- Issue assigned to jtornosm

2 months ago

Metadata Update from @glb:
- Custom field image-editor adjusted to jtornosm
- Custom field publish adjusted to 2022-05-11 (was: 2022-05-06)
- Issue tagged with: article

2 months ago

I have created a new featured image according to the rules.
And I have also included the title in the text of the featured image (I think it is the best text to include).

Metadata Update from @jtornosm:
- Issue untagged with: article

2 months ago

Sorry @glb, it appears again "Issue untagged with: article" and you fixed before ...
What is that? How to fix?
Thanks

@jtornosm I think it is a bug. It's not really important at the moment though, so don't worry about it. :-)

gb

Then the blog is almost finished, great!

If it s possible, I would like to use the image that is currently selected, because it is the real photo of the USB devices that I can emulate.
Let me try to improve the featured image, or at least convert to SVG (if I can)

Are you referring to a new text for the photo? For example this
"A big bunch of USB devices"
Or are you referring to the article introduction text/meta desription?
Is not good/enough the one that is currently included? does it need to be longer?

Sorry for being unclear. The image you chose is great and I have no complaints. What I was trying to say at that time is that just the image itself was bland and didn't say a lot. By adding the text, the featured is a lot better and it's a good start.

I have some critiques: the text is difficult to read because there's a lot going on in the background. The font is light and the background has some light elements as well, which causes some issues with contrast. I suggest adding drop shadows around the text to make it stand out and easier to read.

Additionally, dimming and/or blurring the background should help. Having a clear background makes it more distracting, which can make it harder for us to look at the foreground.

You can take one of my previous featured article as an example, if you have a hard time understanding what I mean: image

I suggest centering the text, both vertically and horizontally. In my opinion, it'll look better.

Lastly, you should appropriately credit the photographer as well. You can go to "Featured image" at the right toolbar, press "Replace Image", switch to the "Media Library" tab, and then add the caption and description.

If everything's good, we should be able to schedule the article!

Thank you very much for your advices!
I think now the featured image is much better.

The photograph was taken by me.
I have filled the caption field with a text that I think can make the article more interesting.

Amazing! Did you make sure you are using an open source font?

Also, could change the caption and mention that you took the picture?

@glb question, since they took the picture, do they have to use an open license? Perhaps we could ask them to license it under the CC-BY-SA?

Thanks!
Yes, I used sans-serif
I have also included my name in caption to show the author, as you commented

@glb question, since they took the picture, do they have to use an open license? Perhaps we could ask them to license it under the CC-BY-SA?

The contributors agree to license what they contribute under the CC-BY-SA license when they sign the FPCA. Their name as displayed at the top of the article is sufficient attribution if it is their own work.

Thanks. I forgot about the FPCA. :sweat_smile:

Do you guys think it's ready for schedule? Everything looks good to me.

@theevilskeleton -- we trust your judgement :-)

Metadata Update from @glb:
- Issue tagged with: article

2 months ago

For me it is perfect!
Thanks

Metadata Update from @glb:
- Custom field publish adjusted to 2022-05-13 (was: 2022-05-11)

2 months ago

Last moment checkup:

Nowadays, there are more and more devices and modern operating systems must try to support all types and several of them with every integration

We should replace "must" with "that".

continuous integration, …

We should replace all instances triple dots ("...") outside of codeblocks with "etc.".

After that, we should be done.

As you commented, I have replaced all instances triple dots ("...") outside of codeblocks with "etc.".

Buit I am not really sure about your first comment: "We should replace "must" with "that"."
Because in that way, I would loose the meaning and strenght.
That is, I would like to say "must try to support", because in other way I think the operating systems are not good.
What do you think?

Thanks

Fair enough. "there are" with "must try to support" don't sound right to me together. We could remove "there are" from the sentence which results in:

Nowadays, more and more devices and modern operating systems must try to support all types and several of them with every integration

Does that sound right?

@glb can I get your input on this?

I don't know ... It sounds better for me with "there are" to get context for " more and more devices".
Let me think about it.

What about this?

"Nowadays, the number of devices is getting bigger and bigger, and modern operating systems must try to support all types and several of them with every integration"

This sounds much better. although, it should be "the number of devices are".

Let me think ...
As I really refer to "number" in signular form and "of devices" is a complement, I think it is singular,
I have used several translators to confirm.
Perhaps I am missing something, why do you think it is plural?

My apologies, I got into a brain fart :sweat_smile:. It should be good now. Should tomorrow be a good fit to schedule to publish the article?

No worries!
I have just modified the sentence: Nowadays ....

Tomorrow is perfect!

Thanks

Alright. I just scheduled for May 14 at 08:00 UTC. @glb could you double check please?

@glb could you double check please?

LGTM 🙂

Perfect! I'm going to close this issue as we are all in agreement.

Metadata Update from @theevilskeleton:
- Issue close_status updated to: scheduled
- Issue status updated to: Closed (was: Open)

2 months ago

Login to comment on this ticket.

Metadata
Boards 1
articles Status: scheduled