Skip to content
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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 51 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Author

@mvbeek mvbeek Jun 12, 2022

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.

cd ssa_iot
make install
```
Expand All @@ -37,10 +37,10 @@ This shell script will take care of the following:
4. Add Environment Variables to `~/.bash_profile`


# Basic Inforamtion
# Basic Information
Copy link
Author

Choose a reason for hiding this comment

The 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
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

spelling correction

- IoT Controller
- IoT Camera
- IoT DoorLock
Expand All @@ -50,25 +50,73 @@ You should start 4 instances parallel.
Instance 1

```
First run
Copy link
Owner

Choose a reason for hiding this comment

The 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

Copy link
Owner

Choose a reason for hiding this comment

The 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
Copy link
Owner

Choose a reason for hiding this comment

The 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

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This blank line is not necessary.

and
brew services start mosquitto
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this command is not necessary as mosquitto -c config/mosquitto.conf will take care of this.


```

Instance 2

```
cd ssa_iot

Copy link
Owner

Choose a reason for hiding this comment

The 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

Copy link
Owner

Choose a reason for hiding this comment

The 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

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This blank line is not ncecessary

source ~/.bash_profile

Copy link
Owner

Choose a reason for hiding this comment

The 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
Copy link
Owner

Choose a reason for hiding this comment

The 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 (config/mosquitto.conf by changing allow_annonymous false to true to remove the access control). So we do not allow this for this assignment.


```

## How to read QR code?
Expand Down