API for accessing RTC devices implemented with kore

Helmut Pozimski 33a63a19c1 implement writing to nvmem on DS1307 vor 5 Jahren
jsonrtc 33a63a19c1 implement writing to nvmem on DS1307 vor 5 Jahren
.gitignore 1a31942b07 Initial commit, add skeleton project for kore vor 5 Jahren
COPYING 8f55debe4d add COPYING and license header vor 5 Jahren
README.md 8f074d95ac implement /device for device detection purposes vor 5 Jahren

README.md

jsonrtc

DISCLAIMER: This Code has been written for demonstration purposes only, it offers no authentikation at all and should not be used in production!

Simple http API to read and write RTC data via JSON implemented with kore and cJSON.

Getting Started

Execute kodev run to start the web service. You can then issue requests to the following endpoints:

  • /time (either GET or POST)
  • /wkalrm (either GET or POST)
  • /device (GET only)

Parameters

A GET request generally requires no parameters, for POST you have to pass a JSON object that follows one of the following formats.

For /time:

{
	"seconds":	int,
	"minutes":	int,
	"hour":	int,
	"mday": int,
	"month":	int,
	"year":	int,
	"wday":	int,
}

For /wkalrm:

{
	"seconds":	int,
	"minutes":	int,
	"hour":	int,
	"mday":	int,
	"month":	int,
	"year":	int,
	"wday":	int,
	"enabled":	int,
	"pending":	int
}

Prerequisites

You will need the following packages installed on your system:

  • kore
  • cJSON

You also should have a compatible RTC device with the rtc-ds13307-driver loaded on your system.

Authors

  • Helmut Pozimski - Initial work - Hoshpak

License

This project is licensed under the GNU General Public License, Version 2 - see the COPYING file for details

Acknowledgments

TBD