search

olliw42 / mLRS-docu

Documentation for the mLRS project
GNU General Public License v3.0
30 stars 10 forks source link

Update MSPX.md #187

Closed b14ckyy closed 2 weeks ago

b14ckyy commented 4 weeks ago

Add INAV Setup steps

jlpoltrack commented 4 weeks ago

Thanks - added a few small comments. In additions where should this live on the main ReadMe? Advanced Options?

olliw42 commented 4 weeks ago

MANY THX. I second jlp's comments. In the pics I would not know where to look at :)

In the first list I think the last bullet could go first, and the first two bullets could become one 2nd bullet, the compression thing could be just a side note (it's really only one message which is compressed)(I would wish it would be more, but...)

where should this live on the main ReadMe? Advanced Options?

I think that's a most important question, which also affects how we want to present this. Currently it's a bit like an odd feature "MspX". It could also be rather INAV/MSP, with mspX being just a comment. It could go into Advanced Options, but I wonder if it might not be placed in Setups. If so it would "screw" up things a bit since most setups are for ArduPilot/PX4/MAVLink ... which is maybe not so clear then when INAV/MSP is added. So a bit of rewording/restructuring might be needed in this section then. I do have no specifc suggestions though.

just my 2 cents

b14ckyy commented 3 weeks ago

Thanks - added a few small comments. In additions where should this live on the main ReadMe? Advanced Options?

Thanks I will address these in a bit.

b14ckyy commented 3 weeks ago

all changes made on the document and rephrased the INAV Version differences in a separate test block. Should be clearer now and more streamlined.

@olliw42 regarding the structure, I find the Readme a bit confusing in general. The "Setups" section would suggest that it has documents that explain the setup of the system step by step but most documents there are mostly technical and feature explanations. Not really setup guides. That was also my main problem when setting up ardupilot for bench testing as I had to jump between multiple documents.

A specific guide for things like Px4, Ardupilot and INAV setup would be nice. Even if it partially just has links to the necessary info docs in the right order.

olliw42 commented 3 weeks ago

I see your point.

Pl feel free to make suggestions and work this out with @jlpoltrack :)

I'm just adding my 2 cents every once in a while here :D

jlpoltrack commented 3 weeks ago

A specific guide for things like Px4, Ardupilot and INAV setup would be nice. Even if it partially just has links to the necessary info docs in the right order.

In the short term - would you view this page as specific enough as a setup for INAV? If so, I wonder if we rename the page as something like 'MspX for INAV'

b14ckyy commented 3 weeks ago

as INAV is the only system validated for use with MSP (when I find time I can see if it works with BF) it would make sense. the INAV guide is generally very short as there is really not much to set up compared to Mavlink.

Alternatively I could extend the guide with a Mavlink Config as well and we split the mspX feature description from the INAV guide to make it a separate doc? So leave the file as it is and my new added part goes into a new INAV.md file?

jlpoltrack commented 3 weeks ago

Alternatively I could extend the guide with a Mavlink Config as well and we split the mspX feature description from the INAV guide to make it a separate doc? So leave the file as it is and my new added part goes into a new INAV.md file?

Would a second page make sense here instead covering MAVLink on INAV or would you prefer all of the INAV stuff on one page?

b14ckyy commented 3 weeks ago

with the minimal settings needed (Its essentially just 2 parameters for MSP and 3 for MAVlink to be set) I am fine with all INAV stuff in one page. We can then link to the MspX, MavlinkX and CRSF info pages as well as the INAV Lua and Yapuu Lua as examples.

More important question is: Would it be ok to have the INAV MAVlink config covered as this will only work with 8.0 and beyond. But that's still in development (although nothing will change until release in the setup process) or should we hold out on this till at least the RC phase?

jlpoltrack commented 3 weeks ago

More important question is: Would it be ok to have the INAV MAVlink config covered as this will only work with 8.0 and beyond. But that's still in development (although nothing will change until release in the setup process) or should we hold out on this till at least the RC phase?

With the single page approach - it would be good to have a section at the start outlining the Pros / Cons / Caveats of using MspX or MAVLink on INAV. Items like MAVLink support still in pre-release could be covered there.

b14ckyy commented 3 weeks ago

Yeah the Pro/Con of each also went through my head after my last post. I will update the PR after work and then you can tell me what you think.

olliw42 commented 3 weeks ago

@b14ckyy @jlpoltrack any progress on this ? just wondering

b14ckyy commented 3 weeks ago

Sorry had a bad week and was barely active anywhere. Will finish it this weekend.

olliw42 commented 3 weeks ago

oh, sorry to hear no pressure, was just curious

jlpoltrack commented 2 weeks ago

Addressed by https://github.com/olliw42/mLRS-docu/pull/189