mellon-web: A REST web service for Mellon controllers

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain]

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:

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

Versions0.7.0.1, 0.7.0.3, 0.7.1.0, 0.7.1.1, 0.8.0.2, 0.8.0.3, 0.8.0.3, 0.8.0.4, 0.8.0.5, 0.8.0.6, 0.8.0.7
Change logchangelog.md
Dependenciesaeson (>=0.11 && <1.3), aeson-pretty (==0.8.*), base (>=4.8 && <5), bytestring (==0.10.*), exceptions (>=0.8.0 && <1), fail (==4.9.*), hpio (>=0.8 && <1), http-client (>=0.4 && <0.6), http-client-tls, http-types (==0.9.*), lens (==4.*), lucid (==2.9.*), mellon-core (==0.8.*), mellon-gpio (==0.8.*), mellon-web, mtl, network (==2.6.*), optparse-applicative (>=0.11.0 && <0.15), semigroups (==0.18.*), servant (==0.11.*), servant-client (==0.11.*), servant-docs (>=0.10 && <0.12), servant-lucid (==0.7.*), servant-server (==0.11.*), servant-swagger (==1.1.*), servant-swagger-ui (==0.2.*), swagger2 (>=2.1 && <2.3), text (==1.2.*), time (>=1.5 && <2), transformers (>=0.4.2 && <0.6), wai (==3.2.*), warp (==3.2.*) [details]
LicenseBSD-3-Clause
CopyrightCopyright (c) 2017, Quixoftic, LLC
AuthorDrew Hess <dhess-src@quixoftic.com>
MaintainerDrew Hess <dhess-src@quixoftic.com>
CategoryWeb
Home pagehttps://github.com/quixoftic/mellon#readme
Bug trackerhttps://github.com/quixoftic/mellon/issues
Source repositoryhead: git clone https://github.com/quixoftic/mellon
Executablesmock-mellon-server, mellon-schedule-unlock, gpio-mellon-server
UploadedThu Jan 11 08:23:56 UTC 2018 by dhess

Modules

[Index]

Flags

NameDescriptionDefaultType
client-unlock-example

Build the unlock client example

EnabledManual
gpio-example

Build the GPIO server example

EnabledManual
mock-example

Build the mock server example

EnabledManual
test-doctests

Build doctests

EnabledManual
test-hlint

Build hlint test

EnabledManual

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainers' corner

For package maintainers and hackage trustees


Readme for mellon-web-0.8.0.3

[back to package description]

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:

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.

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.

Travis CI build status