Difference between revisions of "Install REST"

From xPL
Jump to: navigation, search
(Install Mojolicious Lite)
Line 11: Line 11:
 
for its simplicity and the ease of development.
 
for its simplicity and the ease of development.
  
Before all, make sure you have installed an [[install xpl hub|xPL hub]].
+
Before all, make sure you have installed an [[install xpl hub|xPL hub]]
 +
together with the [[install state|xPL state]] monitor.
  
 
<!--
 
<!--
Line 61: Line 62:
  
 
Check the result in:
 
Check the result in:
  cat /tmp/testRest.log
+
  cat /tmp/xpl-homeStateRest.log
  
 
[[Category: all]] [[Category: install]] [[Category: web]]
 
[[Category: all]] [[Category: install]] [[Category: web]]

Revision as of 15:38, 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

Once installed, one can test the service with:

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, usually on port 3000. 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

Check the result in:

cat /tmp/xpl-homeStateRest.log