search

bluerobotics / ping-viewer

Ping Viewer is an open-source application to view and record data from the Blue Robotics Ping Echosounder and Ping360 Scanning Sonar.
https://docs.bluerobotics.com/ping-viewer/
GNU General Public License v3.0
42 stars 39 forks source link

Docs Update #974

Closed ES-Alexander closed 3 years ago

ES-Alexander commented 3 years ago
ES-Alexander commented 3 years ago

Can we add a section to firmware-update about updating via companion?

I've put a placeholder comment in the file (gets ignored in the generated html) - I'm suggesting we add a subsection to 'Manual Firmware Update'. Would likely be quite useful for people wanting to update firmware without needing to open their ROV (since currently we can't use ping-viewer to update with a UDP connection).

If this is ok to add I'm happy to if someone can tell me which port it would be available on. Would be good to also add this to the companion web interface docs as an available page.

ES-Alexander commented 3 years ago

Not sure if better to merge now (pending response on 'companion' section in firmware-update), or add Ping360 details and extra info first.

patrickelectric commented 3 years ago

I've put a placeholder comment in the file (gets ignored in the generated html) - I'm suggesting we add a subsection to 'Manual Firmware Update'. Would likely be quite useful for people wanting to update firmware without needing to open their ROV (since currently we can't use ping-viewer to update with a UDP connection).

I believe that is better to have such documentation in the companion documentation page, since this is out of the scope of ping-viewer and also could it could open ping-viewer documentation to include things that are not only ping-viewer related but ping-family ecosystem.

But, we could have a reference here in the documentation for the companion webpage.

Not sure if better to merge now (pending response on 'companion' section in firmware-update), or add Ping360 details and extra info first.

This already looks great! Thanks! You can remove the commented topic about the companion update and we could merge ASAP.

You can also work in the other topics in following PRs or finish here if you wish.

ES-Alexander commented 3 years ago

I've put a placeholder comment in the file (gets ignored in the generated html) - I'm suggesting we add a subsection to 'Manual Firmware Update'. Would likely be quite useful for people wanting to update firmware without needing to open their ROV (since currently we can't use ping-viewer to update with a UDP connection).

I believe that is better to have such documentation in the companion documentation page, since this is out of the scope of ping-viewer

Fair enough

and also could it could open ping-viewer documentation to include things that are not only ping-viewer related but ping-family ecosystem.

Agreed. Any thoughts on where ping-family documentation should go? There are the individual product pages on the BR website but the family as a whole doesn't really have a place for documentation - the closest things would be this page and the ping-protocol one.

But, we could have a reference here in the documentation for the companion webpage.

Fair. That can be added once the companion webpage docs have a page for the ping page.

Not sure if better to merge now (pending response on 'companion' section in firmware-update), or add Ping360 details and extra info first.

This already looks great! Thanks! You can remove the commented topic about the companion update and we could merge ASAP.

You can also work in the other topics in following PRs or finish here if you wish.

I'll see what I can get done today. Will confirm within about 10 hours but should be good to merge after that. Anything left afterwards can be handled next week/later.

patrickelectric commented 3 years ago

Agreed. Any thoughts on where ping-family documentation should go? There are the individual product pages on the BR website but the family as a whole doesn't really have a place for documentation - the closest things would be this page and the ping-protocol one.

Maybe we could write or start a webpage for ping-family sensors, is there any topic that you find important for such thing exist ? The only thing common between all sensors from the ping-family is the protocol, but only that from my point of view.

ES-Alexander commented 3 years ago

All done, added a bunch of Ping360 stuff in the various different pages :-)

I think it should all be ok, although someone should check the 'head down' description in display-settings (I can't remember if that's correct, and can't test it)

If there are no required changes please merge, otherwise I’ll try to fix anything missing/incorrect tomorrow morning :-)

ES-Alexander commented 3 years ago

Agreed. Any thoughts on where ping-family documentation should go? There are the individual product pages on the BR website but the family as a whole doesn't really have a place for documentation - the closest things would be this page and the ping-protocol one.

Maybe we could write or start a webpage for ping-family sensors, is there any topic that you find important for such thing exist ? The only thing common between all sensors from the ping-family is the protocol, but only that from my point of view.

Yeah, I'd agree that at this stage the only commonalities are:

It probably wouldn't hurt to make a webpage for the family if it's likely to expand, but at this stage it's probably not worth it because it'd just be duplicating or linking to info that's already elsewhere. Probably better left for another day.

patrickelectric commented 3 years ago

@ES-Alexander, the ping family sensors limit itself to the protocol, we have plans to have products that are not sonars that speak ping-protocol.

patrickelectric commented 3 years ago

Great contributions thanks!