documentation improvements

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Youen Toupin, aka neuoy
+Copyright (c) 2018 Youen Toupin, aka neuoy
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -5,18 +5,4 @@ An arduino library to communicate using the Dallas one-wire protocol, where the
 1-wire allows communication over long distances (100m and more, see Dallas documentation for details) with a single wire (plus a ground wire). You can put as much devices as you want on the same wire (they communicate one at a time). 1-wire also allows to send power over the data wire (parasitic power), but, though I haven't tried, I don't believe it would work with an Arduino. You'll need a separate 5V power source, which, if it comes next to your data wire, means you need 3 wires (5V, data, and ground). You'll also need a master controller, for example the USB adapter DS9490R, to connect to a computer, that will control communication with all 1-wire devices.
 
 ## How to use this library
-This library allows you to emulate existing 1-wire devices with an Arduino, or to create your own protocol. All low-level details are handled by the library, such as reset detection, ROM matching, byte sending and receiving. Look at the demo sketch to see an example.
+Take a look at [the documentation of the library](./documentation.md)
-
-There are only 3 important functions:
-- `void setReceiveCallback(void(*callback)(ReceiveEvent evt, byte data))` sets the function that will be called back when an event occurs, such as when a byte is received
-- `void begin(byte* rom, byte pinNumber)` starts the library, which will respond to the provided ROM (must be unique on your network) on the specified Arduino pin. The ROM is cloned by the library, so you can discard your buffer immediately if you want.
-- `void write(byte* bytes, short numBytes, void(*complete)(bool error))` starts writing one or more bytes, and will call the provided callback (optional) when it's done. The buffer you provide here must stay available until the end of the write operation, which happens in background. Do not use local variables.
-
-## Notes about the interrupt-based implementation
-Since the library is implemented using interrupts, none of its functions will block: you can continue execute your code immediately.
-
-This also means callbacks are called from interrupt handlers, so you must make them very short to not block further communication.
-
-You must also be careful when you explicitely block interrupts, as the 1-wire protocol has very tight timings, especially when writing bytes (which also happens when searching for device ROMs): a delay of 3 microseconds (yes, microseconds, not milliseconds) can be enough for some (quite intolerant) masters to miss a bit.
-
-But if your code only blocks interrupts for reasonably short time, the probability to block exactly at the bad moment is low, so you can easily mitigate the issue by adding CRC checks in your high-level communication protocol, and retrying when an error is detected. This is an important thing to do anyway because 1-wire does not natively perform any error checking (excepted for ROM operations which already contain a CRC byte). Standard 1-wire devices also include CRC checks in their specific protocols.

documentation.md

@@ -0,0 +1,42 @@
+This library allows you to emulate existing 1-wire devices with an Arduino, or to create your own protocol. All low-level details are handled by the library, such as reset detection, ROM matching, byte sending and receiving. Look at the demo sketch to see an example.
+
+# Compatible boards
+
+If you have tested the library on another board, please send a pull-request (or just tell me which board) to update this list.
+
+## ATmega328
+
+- Arduino Uno (tested by [neuoy](https://github.com/neuoy))
+
+# Getting started
+
+See example "FakeDS18B20", and the associated [documentation](examples/FakeDS18B20/README.md), for a working use case of the library.
+
+# Reference
+
+## setReceiveCallback
+
+`void setReceiveCallback(void(*callback)(ReceiveEvent evt, byte data))`
+
+Sets the function that will be called back when an event occurs, such as when a byte is received.
+
+## begin
+
+`void begin(byte* rom, byte pinNumber)`
+
+Starts the library, which will respond to the provided ROM (must be unique on your network) on the specified Arduino pin. The ROM is cloned by the library, so you can discard your buffer immediately if you want.
+
+## write
+
+`void write(byte* bytes, short numBytes, void(*complete)(bool error))`
+
+Starts writing one or more bytes, and will call the provided callback (optional) when it's done. The buffer you provide here must stay available until the end of the write operation, which happens in background. Do not use local variables.
+
+# Notes about the interrupt-based implementation
+Since the library is implemented using interrupts, none of its functions will block: you can continue execute your code immediately.
+
+This also means callbacks are called from interrupt handlers, so you must make them very short to not block further communication.
+
+You must also be careful when you explicitely block interrupts, as the 1-wire protocol has very tight timings, especially when writing bytes (which also happens when searching for device ROMs): a delay of 3 microseconds (yes, microseconds, not milliseconds) can be enough for some (quite intolerant) masters to miss a bit.
+
+But if your code only blocks interrupts for reasonably short time, the probability to block exactly at the bad moment is low, so you can easily mitigate the issue by adding CRC checks in your high-level communication protocol, and retrying when an error is detected. This is an important thing to do anyway because 1-wire does not natively perform any error checking (excepted for ROM operations which already contain a CRC byte). Standard 1-wire devices also include CRC checks in their specific protocols.

examples/FakeDS18B20/README.md

@@ -0,0 +1,16 @@
+This is a **DS18B20** emulator, i.e. it turns an Arduino Uno into a device roughly equivalent to an actual DS18B20 temperature sensor. Excepted in this sample it doesn't actually sense temperature (because the Arduino lacks the hardware for this), it just returns 42 as if that was the expected answer.
+
+To make it work, you will need to connect your Arduino Uno to a 1-wire master (for example an USB adapter on a computer).
+
+You can then connect:
+
+- a GND pin of your Uno to your 1-wire network ground.
+- the pin "2" of your Uno to the data line of your 1-wire network. You may use "3" as well but need to change the code.
+
+You will see 28.000000000002 probe that always return 42 as temperature :
+
+    $ cat 28.000000000002/temperature
+    42
+Conversion timing is emulated as well.
+
+If you don't use an Arduino Uno, you may need to adjust which pin you connect as the data line (it needs to have hardware interrupts), and make the corresponding change in the example source code. A few microcontrollers are compatible with the library, check the full list in [the documentation](../../documentation.md).