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.

Sign up for GitHub

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

Jump to bottom

adding some documentation and a python requirements.txt for ease of use #232

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

adding some documentation and a python requirements.txt for ease of use #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 25 additions & 0 deletions software/chainlink/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Chainlink software

## Python Code

Run the demo by installing the requirement dependencies outlined in the [requirements.txt](./requirements.txt).

### Running the demo

The demo will just send multiple different words to the splitflap board. You may start the demo by executing:

```bash
python demo.py
```

You may get an output looking like this:

```bash
Available ports:
[ 0] /dev/ttyACM0 - USB Single Serial
[ 1] /dev/ttyAMA0 - ttyAMA0
```

Select which port the demo script should execute.

Now the demo should send different words to the splitflap board with short breaks in between them.
1 change: 1 addition & 0 deletions software/chainlink/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
protobuf==3.18.3