Add PiControl documentation #8
Conversation
There was a problem hiding this comment.
Looks great! I think @theopolisme will be better placed to review some of the hardware documentation because I don't really know how to verify how to set those up 😄
| - Raspberry Pi Model 3b+ (but any Raspberry Pi with Wifi capability should work) | ||
|
|
||
| - [USB NFC readers](https://www.amazon.com/gp/product/B07Q5KXM6J/ref=ppx_yo_dt_b_asin_title_o06_s00?ie=UTF8&psc=1). These emulate a keyboard -- when an NFC badge is scanned onto them, they 'type' its ID into whatever they're connected to. | ||
| - **PLEASE** make note of the model: if that link isn't dead, you'll see it links to a '14H' reader. '14H' (or '14D') is required to get the specificity necessary to distinguish between the NFC badge IDs: these readers read the most significant bit first, and since the card IDs are assigned sequentially this means that most of them have the same first 8-10 hex digits. You are in for much pain if you do not purchase the correct readers. |
There was a problem hiding this comment.
I've just added this URL to the wayback machine -- http://web.archive.org/save/https://www.amazon.com/gp/product/B07Q5KXM6J/ref=ppx_yo_dt_b_asin_title_o06_s00?ie=UTF8&psc=1
docs/picontrol.md
Outdated
| - Run `go get -u github.com/gin-gonic/gin github.com/joho/godotenv github.com/lib/pq` | ||
| - Run `npm run dev-start` | ||
|
|
||
| Pushing and pulling to docker: https://ropenscilabs.github.io/r-docker-tutorial/04-Dockerhub.html |
There was a problem hiding this comment.
We don't need to push and pull to docker, though, right? It's just enough to build the docker image locally (i.e. the steps mentioned in the "Installation" section next)?
There was a problem hiding this comment.
I had previously used docker cloud in deployments, but yeah this is no longer necessary and may lead to confusion. Good catch, removing
docs/picontrol.md
Outdated
|
|
||
| #### Development Set-up | ||
|
|
||
| - Set "homepage" in package.json to the url you want. |
There was a problem hiding this comment.
What URL should this be set to? Why does it need to be set?
There was a problem hiding this comment.
Yeah, I was horrible in not specifying. This sets the root url of the frontend to be whatever "homepage" is, but I don't think that's necessary to include in the documentation, as it should be "/admin" in order for everything to work anyway. Will remove
| We used a standard install of Raspbian. You will need to configure the Pi to connect to Wifi -- there are many guides online to do this, such as [this one](https://raspberrypihq.com/how-to-connect-your-raspberry-pi-to-wifi/). | ||
|
|
||
| An installation of Python 3.7 should include all of the necessary dependencies except for [Requests](https://requests.readthedocs.io/en/master/). A 'pip3 install requests' should work, provided you're connected to the internet. | ||
|
|
There was a problem hiding this comment.
Can you add a section here about changing the default password for the raspberry pi's?
Co-authored-by: Ashwin Ramaswami <[email protected]>
"Fix" for #5. This is less complete than I would like it to be, but I've forgotten some details and will need to take a little while to verify. Feel free to leave the issue open if you don't think this is comprehensive enough.