search

NorthernMan54 / homebridge-mcuiot

Homebridge platform plugin that support's a network of nodemcu's running nodemcu-dht-yl69-mdns to display Temperature and Humidity.
30 stars 11 forks source link

Some beginner documentation #27

Closed agruen closed 5 years ago

agruen commented 5 years ago

@NorthernMan54 not sure the best place to put this, but I'm running a seminar at the Berkman-Klein Center on IoT and am teaching homebridge-mcuiot... As a result, I put together some documentation designed for absolute beginners. You're welcome to it -- and I'm happy to tweak if you have an idea for making it better.

NorthernMan54 commented 5 years ago

Tks for sharing this, it looks really good. If you don’t mind I will add this link to the Readme as it will really help other new users.

On Feb 28, 2019, at 11:16 AM, Andrew Gruen notifications@github.com wrote:

@NorthernMan54 not sure the best place to put this, but I'm running a seminar at the Berkman-Klein Center on IoT and am teaching homebridge-mcuiot... As a result, I put together some documentation designed for absolute beginners. You're welcome to it -- and I'm happy to tweak if you have an idea for making it better.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

agruen commented 5 years ago

Go for it. Happy to put it wherever you think would be most helpful. Just too me too long to combine a bunch of different resources into one place... Thought others would benefit :)

NorthernMan54 commented 5 years ago

I was thinking of just putting the link to your current hosting, or should it pull it into the Repo, and have GitHub host it. I also have a website as well, but it is used for my Alexa skill. And I could drop the content there as well.

Https://www.homebridge.ca

On Feb 28, 2019, at 2:45 PM, Andrew Gruen notifications@github.com wrote:

Go for it. Happy to put it wherever you think would be most helpful.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

agruen commented 5 years ago

Sure thing, link away! everything is already on GitHub anyway (workingpaper.co is a GitHub pages site). If you want, I can replicate the content into the Wiki in the project, or just do a pull request and add an extra page here, too.

At some point, I'll also do an ultra-beginner-guide to setting up homebridge in docker on a raspberry pi zero w (that's what I'm directing folks to do in the seminar).

NorthernMan54 commented 5 years ago

I was thinking about the this for further and the wiki makes perfect sense as it’s very close to the code, and don’t have to worry about hosting issues, and gives people a perfect method of contact in case of issues.

agruen commented 5 years ago

I'll pop it up tonight.

On Mon, Mar 4, 2019 at 3:18 PM Northern Man notifications@github.com wrote:

I was thinking about the this for further and the wiki makes perfect sense as it’s very close to the code, and don’t have to worry about hosting issues, and gives people a perfect method of contact in case of issues.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/NorthernMan54/homebridge-mcuiot/issues/27#issuecomment-469425381, or mute the thread https://github.com/notifications/unsubscribe-auth/AAtn_UwMro525dLI0Y-avdVePN-ZZuwiks5vTY2IgaJpZM4bXL_o .

agruen commented 5 years ago

I might be dense... But I can't figure out how to add a page to a wiki that doesn't yet exist? Can you initialize the wiki?

NorthernMan54 commented 5 years ago

Done

On Mar 5, 2019, at 12:26 PM, Andrew Gruen notifications@github.com wrote:

I might be dense... But I can't figure out how to add a page to a wiki that doesn't yet exist? Can you initialize the wiki?

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub, or mute the thread.

agruen commented 5 years ago

And in the longest thread ever to do something incredibly simple: https://help.github.com/en/articles/changing-access-permissions-for-wikis

Sorry, I didn't realize it wouldn't let me edit! 🤦‍♂️

NorthernMan54 commented 5 years ago

Lol, is this a picnic or a id10t problem?

I made yourself a colaborator and removed the restriction to just collaborators 150f9992-139d-4b37-b8b9-11cf3505c4c4

agruen commented 5 years ago

🥳

All set!

At the moment, I'm linking to images and files hosted by me -- if you want to upload them to the repo to host them here, feel free. All zipped up here.

Happy to continue doing this kind of thing if there are places people get continually tripped up.

NorthernMan54 commented 5 years ago

That looks spectacular, thanks again.

When I back from vacation next week, I will update the README etc

Sent from my iPad

On Mar 6, 2019, at 12:37 AM, Andrew Gruen notifications@github.com wrote:

🥳

All set!

At the moment, I'm linking to images and files hosted by me -- if you want to upload them to the repo to host them here, feel free. All zipped up here.

Happy to continue doing this kind of thing if there are places people get continually tripped up.

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub, or mute the thread.

agruen commented 5 years ago

👍

So, I ran the seminar today, and learned a few things:

  1. People struggled to download all the Lua files. Can we zip them all, and add that zip to the repo, then link to it from the wiki? (instead of downloading the files, they repeatedly downloaded the entire html GitHub page...)
  2. ESPlorer is tough. Do you know if there's anything better? (I doubt it, but figured it's worth asking) This weekend, I might play with that part of the wiki to add more screenshots...
  3. Folks are blown away by this stuff. Turns out it's a great intro into hardware hacking!
NorthernMan54 commented 5 years ago

Here is something to ponder a bit, this is my latest nodemcu package I worked on in December to support Xmas lights etc.

It features ota provisioning after initial load, and uses a script to download the initial files. My documentation on this is a bit less user friendly, and at this time it deploys an led strip controller but pieces could be backported to mcuiot. My vision was to deprecate my mcuiot and wssensor code bases, and migrate all to this, then I got distracted with my NodeRed and Alexa projects.

Sent from my iPad

On Mar 7, 2019, at 11:11 PM, Andrew Gruen notifications@github.com wrote:

👍

So, I ran the seminar today, and learned a few things:

People struggled to download all the Lua files. Can we zip them all, and add that zip to the repo, then link to it from the wiki? (instead of downloading the files, they repeatedly downloaded the entire html GitHub page...) ESPlorer is tough. Do you know if there's anything better? (I doubt it, but figured it's worth asking) This weekend, I might play with that part of the wiki to add more screenshots... Folks are blown away by this stuff. Turns out it's a great intro into hardware hacking! — You are receiving this because you were assigned. Reply to this email directly, view it on GitHub, or mute the thread.

NorthernMan54 commented 5 years ago

Also a big congrats

Sent from my iPad

On Mar 7, 2019, at 11:11 PM, Andrew Gruen notifications@github.com wrote:

👍

So, I ran the seminar today, and learned a few things:

People struggled to download all the Lua files. Can we zip them all, and add that zip to the repo, then link to it from the wiki? (instead of downloading the files, they repeatedly downloaded the entire html GitHub page...) ESPlorer is tough. Do you know if there's anything better? (I doubt it, but figured it's worth asking) This weekend, I might play with that part of the wiki to add more screenshots... Folks are blown away by this stuff. Turns out it's a great intro into hardware hacking! — You are receiving this because you were assigned. Reply to this email directly, view it on GitHub, or mute the thread.

agruen commented 5 years ago

OK, that's super interesting. I'm on the plane back home, can't mess with it now. Let me see if I can get it working this weekend (I assume I can just use the NodeMCU bits to see how it works, without having the lighting equipment?)... If it works like I'm reading, could be a huge advance in usability. And, looks like it might even be bash-scriptable? (Except for the single ESPlorer step...). I can already see a pi hole-like installer...

NorthernMan54 commented 5 years ago

Just an FYI - I have updated the README, and pointed to the WIKI now for build instructions and have also given yourself credit for the documentation. And have also changed the "working papers" links to ones in the REPO itself. Tks very much again.