Skip to content

Commit 3166613

Browse files
committed
Update README.md
1 parent 198ff22 commit 3166613

1 file changed

Lines changed: 34 additions & 1 deletion

File tree

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,35 @@
11
# ST25DV
2-
Arduino library to support ST25DV components
2+
Arduino library to support the NFC ST25DV components:
3+
* ST25DV04K
4+
* ST25DV64K
5+
6+
## API
7+
8+
This NFC sensor uses I2C to communicate.
9+
It creates the instance st25dv.
10+
11+
It is then required to call begin API with the 2 pins to be used before accessing to the sensors, and optionally wire instance:
12+
` st25dv->begin(gpo_pin, lpd_pin);`
13+
or
14+
```
15+
TwoWire MyWire(SDA_PIN, SCL_PIN);
16+
st25dv->begin(gpo_pin, lpd_pin, MyWire);
17+
```
18+
19+
20+
It is then possible to read/write NFC URI:
21+
22+
```
23+
int writeURI(String protocol, String uri, String info);
24+
String readURI();
25+
```
26+
27+
28+
## Documentation
29+
30+
You can find the source files at
31+
https://github.com/stm32duino/ST25DV
32+
33+
The ST25DV datasheets are available at
34+
https://www.st.com/content/st_com/en/products/nfc/st25-nfc-rfid-tags-readers/st25-dynamic-nfc-tags/st25dv-i2c-series-dynamic-nfc-tags/st25dv04k.html
35+
https://www.st.com/content/st_com/en/products/nfc/st25-nfc-rfid-tags-readers/st25-dynamic-nfc-tags/st25dv-i2c-series-dynamic-nfc-tags/st25dv64k.html

0 commit comments

Comments
 (0)