-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update README from Mat #14
base: main
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,7 +16,7 @@ The following should be installed already before setup. | |
## Install Necessary Source Code and Libraries | ||
|
||
``` | ||
git clone https://github.com/ShotaKameyama/ssa_iot.git` | ||
git clone https://github.com/ShotaKameyama/ssa_iot.git | ||
cd ssa_iot | ||
make install | ||
``` | ||
|
@@ -37,10 +37,10 @@ This shell script will take care of the following: | |
4. Add Environment Variables to `~/.bash_profile` | ||
|
||
|
||
# Basic Inforamtion | ||
# Basic Information | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. spelling correction |
||
|
||
This IoT system consists of 4 instances: | ||
- MQTT braker | ||
- MQTT broker | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. spelling correction |
||
- IoT Controller | ||
- IoT Camera | ||
- IoT DoorLock | ||
|
@@ -50,25 +50,73 @@ You should start 4 instances parallel. | |
Instance 1 | ||
|
||
``` | ||
First run | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @mvbeek in the code section, can you remove the explanation? please include the command. |
||
brew install librdkafka | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. also line brake is not necessary |
||
then | ||
make install | ||
|
||
To view brew services to make sure mosquitto has started | ||
brew services list | ||
|
||
then run | ||
git branch | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. these git commands are not necessary. |
||
git log | ||
git pull | ||
|
||
then | ||
mosquitto -c config/mosquitto.conf | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This blank line is not necessary. |
||
and | ||
brew services start mosquitto | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this command is not necessary as |
||
|
||
``` | ||
|
||
Instance 2 | ||
|
||
``` | ||
cd ssa_iot | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. also please remove the line brake for consistency. Please apply to all the code section. |
||
source ~/.bash_profile | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This blank line is not necessary. |
||
python3 iot_controller.py | ||
``` | ||
|
||
Instance 3 | ||
|
||
``` | ||
cd ssa_iot | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This blank line is not ncecessary |
||
source ~/.bash_profile | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This blank line is not necessary |
||
python3 iot_client_doorlock.py | ||
``` | ||
|
||
Instance 4 | ||
|
||
``` | ||
First run these commands: | ||
|
||
pip install pyaml-env | ||
|
||
pip install pyzbar | ||
|
||
brew install zbar | ||
|
||
vim config/config.yml | ||
|
||
brew install opencv | ||
(This command can take some time to install, please be patient) | ||
|
||
python3 iot_client_camera.py | ||
|
||
``` | ||
|
||
To monitor commands in MQTT use the below command in a new terminal | ||
|
||
``` | ||
mosquitto_sub -t "#" -h localhost -v | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For the security reasons, this has to be blocked by the access control (I have changed your config file ( |
||
|
||
``` | ||
|
||
## How to read QR code? | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
extra ` which when copied made the code not work when copied.