The mellon-web package
The mellon-web package wraps a mellon-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, the mellon-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 (either Locked or Unlocked date where date 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.
[Skip to Readme]
Properties
| Versions | 0.7.0.1, 0.7.0.3, 0.7.1.0, 0.7.1.1 |
|---|---|
| Change log | changelog.md |
| Dependencies | aeson (>=0.11 && <1.3), aeson-pretty, base (>=4.8 && <5), bytestring (==0.10.*), exceptions (>=0.8.0 && <1), hpio (>=0.8 && <1), http-client (>=0.4 && <0.6), http-client-tls, http-types (==0.9.*), lens, lucid (==2.9.*), mellon-core (==0.7.*), mellon-gpio (==0.7.*), mellon-web, mtl, network (==2.6.*), optparse-applicative (>=0.11.0 && <0.14), servant (==0.9.*), servant-client (==0.9.*), servant-docs (==0.9.*), servant-lucid (>=0.7.1 && <0.10), servant-server (==0.9.*), servant-swagger, servant-swagger-ui, swagger2, text (==1.2.*), time (>=1.5 && <2), transformers (>=0.4.2 && <0.6), wai (==3.2.*), warp (==3.2.*) [details] |
| License | BSD3 |
| Copyright | Copyright (c) 2017, Quixoftic, LLC |
| Author | Drew Hess <dhess-src@quixoftic.com> |
| Maintainer | Drew Hess <dhess-src@quixoftic.com> |
| Category | Web |
| Home page | https://github.com/quixoftic/mellon/ |
| Bug tracker | https://github.com/quixoftic/mellon/issues/ |
| Source repository | head: git clone git://github.com/quixoftic/mellon.git this: git clone git://github.com/quixoftic/mellon.git(tag v0.7.1.1) |
| Uploaded | Thu May 25 00:20:11 UTC 2017 by dhess |
| Distributions | NixOS:0.7.1.1 |
| Downloads | 164 total (18 in the last 30 days) |
| Votes | |
| Status | Docs uploaded by user Build status unknown [no reports yet] Hackage Matrix CI |
Modules
[Index]
Flags
| Name | Description | Default | Type |
|---|---|---|---|
| test-doctests | Enabled | Manual | |
| test-hlint | Enabled | Manual | |
| mock-example | Enabled | Manual | |
| gpio-example | Enabled | Manual | |
| client-unlock-example | Enabled | Manual |
Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info
Downloads
- mellon-web-0.7.1.1.tar.gz [browse] (Cabal source package)
- Package description (included in the package)
Readme for mellon-web
Readme for mellon-web-0.7.1.1
mellon-web
The mellon-web package wraps a mellon-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, the mellon-web REST API
is quite simple. There are only 3 methods:
GET /timereturns the system time on the server. This is made available for diagnostic purposes, primarily to ensure the server has an accurate clock.GET /statereturns the controller's current state (eitherLockedorUnlocked datewheredateis the UTC time at which the controller will automatically lock again).PUT /statesets the controller's current state. Use this method to lock and unlock the controller.
See API.md 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.
Example servers
"Mock" server
An extremely simple example server (with on-line documentation
support) is provided in the examples directory. You can run it with
cabal run mock-mellon-server and test it using the endpoints
described in API.md. The server is will run on the
localhost loopback interface on port 8081.
Also included is a Paw file with a
pre-defined localhost environment for use with the example server.
This particular example server uses a "mock lock" device which only internally logs lock and unlock events without depending on any actual hardware, so it will run anywhere.
GPIO server
Another included example server uses the mellon-gpio package to
drive a simple physical access device via a GPIO pin. This server must
be run on a Linux host with GPIO hardware, e.g., a Raspberry Pi
running Linux.
This server takes a GPIO pin number and a local port number, then
starts a mellon-web server on all local interfaces on the specified
port. When the server receives an unlock request, it will drive a high
signal on the specified GPIO pin. When the unlock expires, or when the
server receives a lock request, it will drive a low signal on the
specified GPIO pin.
To use this server, simply connect a properly-designed physical access device (e.g., an electric strike driven by a relay circuit such as the one shown here) to an available GPIO pin on the host device, then run the server with the specified GPIO pin number and port. For example, to run the server on port 7533 using GPIO pin 65:
cabal run gpio-mellon-server -- sysfs --port 7533 65
The sysfs command tells the server to use the Linux sysfs GPIO
interpreter. (Currently, this is the only supported GPIO platform.)
NOTE: the REST service provided by gpio-mellon-server offers no
security/authentication for your access control device! You should
always run it (or any mellon-web server) behind a secure proxy web
service or equivalent HTTP(S)-based authentication mechanism.
