Skip to content

Commit 17e0e09

Browse files
author
Kevin Townsend
committed
Updated the readme for UART service
1 parent db6191b commit 17e0e09

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed
+23-10
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,34 @@
1-
Project Name
1+
UART Service
22
============
33

4-
About this project
4+
This project shows how custom services and characteristics can be defined and manipulated on the nRF51822.
5+
6+
A sample 'UART' type service with two characteristics as follows:
7+
8+
- The first characteristic acts as a **TXD** line, with **indicate** enabled, which allows us to know definitively if the transmitted data was received or not.
9+
10+
- The second characteristic acts as the **RXD** line and has **write** enabled so that the connected GATT client device (the phone/tablet/etc.) can send data back to the GATT server (the nRF51822).
11+
12+
Target SDK/SD
13+
=============
14+
15+
- **SDK**: v5.1.0
16+
- **SoftDevice**: v6.0.0
517

618
Building this Project
719
=====================
820

921
To build a clean copy of your project in release mode, enter the same folder as your Makefile on the command-line and enter the following command:
1022

11-
- make clean release
23+
```
24+
make clean release
25+
```
1226

1327
Other relevant make targets are:
1428

15-
- make
16-
- make debug
17-
- make flash-softdevice (flashes Softdevice via JLink)
18-
- make flash (flashes output hex file via JLink)
19-
- make erase-all (erases flash)
20-
- make startdebug - (starts GDBServer & GDB via JLink)
21-
- make stopdebug - (stops GDBServer)
29+
- `make` is an alias for `make debug` below
30+
- `make debug` builds a .hex file that includes debug data (larger, unoptimized binaries useful to debug via GDB Server)
31+
- `make release` builds an optimized release version of the firmware
32+
- `make clean` removes and previous build artifacts
33+
- `make flash` flashes the nRF51 via JLink and nrfjprog.exe (currently Windows only)
34+

0 commit comments

Comments
 (0)