lora-irrigation/README.md

Syote: Secure IoT
=================

This project started off as a project to control an [irrigation system
via a LoRa radio](LORA-IRR.md), but the core architecture of the
communication and security can easily be reused for other projects.

The projects that make use of the core protocol are included in this
repo to make development easier for now, but if/when the project gets
large enough, they will be broken out into their own repositories.

Projects
--------

[LoRa Irrigation](LORA-IRR.md):  Control over LoRa radio.

[RS-485 USB HID KVM](RS485HID.md): USB Keyboard over RS-485

File Layout
-----------

Note that things are a mess as they stand right now.  The first project
was based upon the SemTech reference code which implemented their own
HAL on top of ST's HAL which is partly implemented on top of ARM's HAL,
and in some cases bypasses them.  It was also originally written not
expecting to be used for another board.

board/ - Board specific code
loramac/ - SemTech reference code.  Has reference code for LoRa and the
	   Node151 based board.
mk/ - Files supporting the build infrastructure.
rs485hid/ - Files relating to the RS-485 HID project
stm32/ - This is the HAL for ST based parts.  It comtains the ARM CMSIS
	 HAL as well, for the parts the ST chose to use.
strobe/ - Crypto code that form the basis of the protocol.

Options
-------

Default on:
STROBE - This contains all the cryptography parts.
SYSINIT - This contains the initalization frmae work, similar to FreeBSD.

Default off:
NODE151 - Code necessary for the Heltech Node151 module.
RS485FRAME - Code implementing framing tx/rx over RS-485.
STM32F103 - Code for a STM32F103 based board.
SX1276 - Code necessary for the LoRa Radio.
USB_CDC - Code for implementing a USB CDC Endpoint.

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://casual-effects.com/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>