Skip to content

Updated OSH Docs for OSH Connect Python#13

Open
eric-ott wants to merge 6 commits into
opensensorhub:masterfrom
Botts-Innovative-Research:osh-connect-python-Getting-started
Open

Updated OSH Docs for OSH Connect Python#13
eric-ott wants to merge 6 commits into
opensensorhub:masterfrom
Botts-Innovative-Research:osh-connect-python-Getting-started

Conversation

@eric-ott

Copy link
Copy Markdown

The current website is severely outdated. After working with Ian to set up an OSH Connect system, I updated the OSH Connect for the documents.

##Problem

  1. The commands were extremely outdated
  2. Language was confusing for someone who has never worked with OSH Connect before

##Fixes

  1. I took the commands from the Python docs and replaced them with the current commands in the OSH Connect docs
  2. Just explained a little more, from what OSH Connect is, that you need a running OSH Node (linked to it) to get this to work, and any additional comments I added to give explanations and clarification for those who are new to the OSH Library.
  3. Added a link to the actual Python docs, which go more in depth than the current website docs.

##Comments
I have not fixed the parts about connecting a system since I have not connected a system yet, only used OSH Connect to get data from the Node. Additionally, these docs do not go over MQTT and any of the specifics of the connected systems, which is why I added the link for Python, but that is not present for the Java and C++ libraries.

eric-ott added 6 commits July 15, 2026 18:52
1. added the notes about needing prerelease=allow, and the reason to why.

2. Added the correct command to get the library installed
in usage.md

I just updated the commands one can copy from the website, since all the pervious updates were outdated and half the libraries there are importing no longer exist.
Added a section that goes over that one must get a running OSH Node set up. And adds the link to get there.
Updates link in installation, to go from requirements to introduction instead

Just made the lanaguge more clear for instructions, From the top and stopping at Resource Insertion

NEED TO CONTINUE ON RESOURCE INSERTION AFTER I WORK FULLY WITH THOSE COMMANDS
some text was not proper
@vercel

vercel Bot commented Jul 21, 2026

Copy link
Copy Markdown

@eric-ott is attempting to deploy a commit to the Alex Almanza's projects Team on Vercel.

A member of the Team first needs to authorize it.

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

Successfully merging this pull request may close these issues.

1 participant