Skip to content

Commit e34fa4d

Browse files
squirclesquircle
committed
documentation updates
1 parent b3a4cc0 commit e34fa4d

5 files changed

Lines changed: 88 additions & 36 deletions

File tree

‎README.md‎

Lines changed: 30 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,30 @@
1-
# CycleFlow Android Client
2-
***
3-
```
4-
\_____/
5-
/ . . \
6-
_|_________|_
7-
| | | |
8-
| | | |
9-
.-``' _o '-|_________|-'
10-
.` .` _ \<_ | | | |
11-
_.-' '.__(_)/(_)__________'-' '-'
12-
```
13-
14-
Client component for CEG 4912/4913 Capstone Project at the University of Ottawa.
15-
16-
Developed in 2018 alongside the `cycleflow-hw` base station component.
17-
18-
## Description
19-
* Simple CycleFlow-compatible app to serve as a proof-of-concept and potential example for alternative clients
20-
* Simulate location data
21-
* Decode and display CycleFlow broadcasts
22-
23-
## Requirements
24-
* Requires Android 5.0 or higher
25-
* Requires Google Play Services
26-
* Requires Location and Bluetooth permissions
27-
* Requires Google Maps API key (NOT PROVIDED)
28-
* For full experience, deployment of CycleFlow-compatible base stations is required.
29-
30-
## How to build
31-
* Import project into Android Studio
32-
* Any missing Android or Google dependencies can then be automatically installed
33-
* Build project
34-
* Deploy on physical Android device for best results (tested on LG V20, Samsung A5 2017, Moto G4)
1+
# CycleFlow
2+
3+
CycleFlow is a project of Andrew Dam, Mitchell Kovacs, Noah Kruiper, and
4+
Tyson Moore for the CEG 4912/4913 Capstone design project courses at the
5+
University of Ottawa.
6+
7+
CycleFlow encourages the efficient use of active transportation in cities by
8+
transmitting traffic signal timing information to cyclists. This allows them to
9+
conserve momentum and reduces effort to safely glide through urban corridors.
10+
11+
This repository consists of two components: a sample base station implementation
12+
using Nordic Semiconductor's nRF52-DK development kit, and a sample client
13+
implementation using Android. A description of the protocol can be found in
14+
the integration guide (in the `doc/` directory).
15+
16+
More information on each project can be found in the `README.md` in the
17+
respective directories.
18+
19+
## CycleFlow Android Client
20+
21+
The CycleFlow Android client (in `cycleflow-android/`) is a proof-of-concept
22+
Android application implementing the CycleFlow protocol. It can use real or
23+
simulated location data to decode and display information from CycleFlow base
24+
stations.
25+
26+
## CycleCaster
27+
28+
The CycleCaster is a CycleFlow base station using the nRF52 series Bluetooth
29+
SoC. It can run internal timing demonstrations with static data, and is designed
30+
to be integrated with traffic signal control systems.

‎cyclecaster/README.md‎

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,24 @@
1-
# cycleflow-hw
2-
Repository for Cycleflow hardware development
1+
# CycleCaster
2+
3+
The CycleCaster is a CycleFlow base station using the nRF52 series Bluetooth
4+
SoC. It can run internal timing demonstrations with static data, and is designed
5+
to be integrated with traffic signal control systems.
6+
7+
## Requirements
8+
9+
Building this project requires:
10+
11+
- Nordic Semiconductor's nRF52 SDK v15.2.0 (submodule, or [link](https://developer.nordicsemi.com/nRF5_SDK/nRF5_SDK_v15.x.x/))
12+
- GNU toolchain for ARM Cortex M ([link](https://developer.arm.com/open-source/gnu-toolchain/gnu-rm/downloads))
13+
- nRF5x Command Line Tools ([link](http://infocenter.nordicsemi.com/index.jsp?topic=%2Fcom.nordic.infocenter.tools%2Fdita%2Ftools%2Fnrf5x_command_line_tools%2Fnrf5x_installation.html))
14+
- GCC and GNU Make
15+
- (Optional) SEGGER J-Link software (for debugging) ([link](https://www.segger.com/downloads/jlink/))
16+
17+
## Building
18+
19+
1. Edit the `Makefile` in `cyclecaster-nrf52/pca10040/s132/armgcc/` to reflect the SDK path (if you are using the submodule, no changes are necessary)
20+
2. Edit `Makefile.posix` or `Makefile.windows` in `$SDK_ROOT/components/toolchain/gcc/` to reflect the version and path of the GNU ARM toolchain
21+
4. Run `make` to test the configuration
22+
3. Make sure `nrfjprog` is in your `$PATH`
23+
4. Connect your nRF52-DK via USB
24+
5. Run `make flash` to program the development kit

‎cycleflow-android/README.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# CycleFlow Android Client
2+
***
3+
```
4+
\_____/
5+
/ . . \
6+
_|_________|_
7+
| | | |
8+
| | | |
9+
.-``' _o '-|_________|-'
10+
.` .` _ \<_ | | | |
11+
_.-' '.__(_)/(_)__________'-' '-'
12+
```
13+
14+
Client component for CEG 4912/4913 Capstone Project at the University of Ottawa.
15+
16+
Developed in 2018 alongside the `cycleflow-hw` base station component.
17+
18+
## Description
19+
* Simple CycleFlow-compatible app to serve as a proof-of-concept and potential example for alternative clients
20+
* Simulate location data
21+
* Decode and display CycleFlow broadcasts
22+
23+
## Requirements
24+
* Requires Android 5.0 or higher
25+
* Requires Google Play Services
26+
* Requires Location and Bluetooth permissions
27+
* Requires Google Maps API key (NOT PROVIDED)
28+
* For full experience, deployment of CycleFlow-compatible base stations is required.
29+
30+
## How to build
31+
* Import project into Android Studio
32+
* Any missing Android or Google dependencies can then be automatically installed
33+
* Build project
34+
* Deploy on physical Android device for best results (tested on LG V20, Samsung A5 2017, Moto G4)

cyclecaster/doc/cycleflow-integration-guide.pdf renamed to doc/cycleflow-integration-guide.pdf

File renamed without changes.

cyclecaster/doc/cycleflow-integration-guide.tex renamed to doc/cycleflow-integration-guide.tex

File renamed without changes.

0 commit comments

Comments
 (0)