mellon-web
Version 0.7.0.1 revision 0 uploaded by dhess.
Package meta
- Synopsis
- A REST web service for Mellon controllers
- Description
The
mellon-web
package wraps amellon-core
controller in a REST web service, making it possible to control physical access devices from an HTTP client. The package includes both a WAI application server, and native Haskell client bindings for the service.Like the
mellon-core
controller interface, themellon-web
REST API is quite simple. There are only 3 methods:GET /time
returns the system time on the server. This is made available for diagnostic purposes, primarily to ensure the server has an accurate clock.GET /state
returns the controller's current state (eitherLocked
orUnlocked date
wheredate
is the UTC time at which the controller will automatically lock again).PUT /state
sets the controller's current state. Use this method to lock and unlock the controller.
See the included API.md document for detailed documentation on the REST service.
Note that the
mellon-web
server does not provide an authentication mechanism! You should proxy it behind a secure, authenticating HTTPS server such as Nginx.- Author
- Drew Hess <src@drewhess.com>
- Bug reports
- https://github.com/dhess/mellon/issues/
- Category
- Web
- Copyright
- Copyright (c) 2016, Drew Hess
- Homepage
- https://github.com/dhess/mellon/
- Maintainer
- Drew Hess <src@drewhess.com>
- Package URL
- n/a
- Stability
- experimental