Difference between revisions of "Install REST"

From xPL
Jump to: navigation, search
(Install Mojolicious Lite)
(Test the REST server)
Line 61: Line 61:
 
  REST_PORT=33865
 
  REST_PORT=33865
 
  curl -X GET localhost:$REST_PORT/state/study/lights/ceiling && echo
 
  curl -X GET localhost:$REST_PORT/state/study/lights/ceiling && echo
 +
curl -X PUT localhost:$REST_PORT/state/study/lights/ceiling/on
 
<!--
 
<!--
 
  curl -X GET localhost:$REST_PORT/test/hello/world?'a=b&c=d'
 
  curl -X GET localhost:$REST_PORT/test/hello/world?'a=b&c=d'

Revision as of 16:57, 25 May 2020

Controlling the home from distance can be made via standard web access methods such as the RESTful API.

Different options are available for the implementation of such a service:

  • Installing a web server and writing CGI scipts
  • Writing scripts serving a TCP socket and complying to the HTTP scheme
  • Using a framework such as:

I have chosen Mojolicious Lite for its simplicity and the ease of development.

Before all, make sure you have installed an xPL hub together with the xPL state monitor.


Install Mojolicious Lite

Mojolicious::Lite can be installed with the standard CPAN method. For Debian and related distributions such as Ubuntu, a dedicated option is to use:

sudo apt install libmojolicious-perl

Test the REST server

Download the xPL home state REST interface script.

Start the server:

REST_PORT=33865
REST_SERVICE_DIRECTORY='/home/control/Documents/Controls'
morbo -l http://*:$REST_PORT $REST_SERVICE_DIRECTORY/xpl-homeStateRest.pl

This starts an HTTP service. Each time the Perl script is updated, the service is updated too. Interpretor errors are displayed in the terminal in whick the morbo runs.

Test the service in another terminal window:

REST_PORT=33865
curl -X GET localhost:$REST_PORT/state/study/lights/ceiling && echo
curl -X PUT localhost:$REST_PORT/state/study/lights/ceiling/on

Check the result in:

cat /tmp/xpl-homeStateRest.log