M README.md => README.md +19 -19
@@ 2,34 2,34 @@
[![Weather station with an e-paper display](https://files.krystianch.com/tiny-weather-sm.jpg)](https://files.krystianch.com/tiny-weather.jpg)
-*Tiny weather* is a customizable weather station with an e-paper display.
-It works with arbitrary number of wireless probes that measure ambient
+*Tiny Weather* is a weather station with an e-paper display.
+It works with an arbitrary number of wireless probes that measure ambient
temperature, humidity and pressure.
-Each probe can be powered by two AA batteries with for a whole-year battery life
-or from a mains socket for uninterrupted operation.
-
-The display can be customized for a number of applications:
-* monitoring ambient conditions in multiple rooms at the same time,
-* monitoring temperature in a refrigerator,
-* monitoring temperature in housing for livestock,
-* monitoring humidity in a dry box,
-* monitoring atmospheric pressure for weather forcasting,
-* recording the lowest temperature in the last 12 h in winter,
-* recording the highest temperature in the last 12 h in summer,
-* the combination of above,
-* and many more.
-
+Each probe is powered by two AA batteries with an eight-month battery life
+or with a mains power supply for uninterrupted operation.
The name *Tiny Weather* comes from ATtiny microcontrollers that power the
probes.
+## Sources
+
+* [transmitter/](transmitter/) -- probe program source code
+* [receiver/](receiver/) -- receiver program source code
+* [hardware/tiny-weather-tx/](hardware/tiny-weather-tx/) -- probe schematic and PCB layout
+* [hardware/tiny-weather-rx/](hardware/tiny-weather-rx/) -- receiver schematic and PCB layout
+* [hardware/tiny-weather-rx-enclosure.scad](hardware/tiny-weather-rx-enclosure.scad) -- receiver enclosure 3D model
+
## Documentation
-* [Assembly instructions](docs/assembly.md)
+* [docs/assembly.md](docs/assembly.md) -- assembly instructions
+* [docs/theory-of-operation.md](docs/theory-of-operation.md) -- theory of operation
-## Development resources
+## Resources
-* [RF Monolithics Virtual Wire protocol](https://files.krystianch.com/tr_swg05.pdf)
* [RTL-SDR Blog V3](https://www.rtl-sdr.com/buy-rtl-sdr-dvb-t-dongles/)
(software defined radio for RF debugging)
* [rtl_443 fork](https://git.sr.ht/~krystianch/rtl_433) (decoder)
* [tiny-hvsp](https://git.sr.ht/~krystianch/tiny-hvsp) (fuse resetter)
+
+## License
+
+[MIT](LICENSE.txt)
M docs/protocol.md => docs/protocol.md +4 -2
@@ 1,7 1,9 @@
# Tiny Weather Protocol
-The wireless communication protocol is based on the RF Monolithics Virtual Wire
-protocol (see development resources below).
+The wireless communication protocol is based on the RF Monolithics
+[Virtual Wire][1] protocol.
+
+[1]: https://files.krystianch.com/tr_swg05.pdf
## Packet structure