Skip to main content

WebService (REST and WebSocket) to access and controller your Pedal Pi pedals set configurations

Project description

Build Status Code coverage Code Health

Pedal Pi - WebService is a Pedal Pi component that offers a Pedal Pi management over REST + WebSocket.

WebService also supports auto discover: by publishing to the network using zeroconf, it offers a certain level of location transparency, allowing applications to connect to the WebService with minimal user effort.

Documentation:
http://pedalpi.github.io/WebService/
Code:
https://github.com/PedalPi/WebService
Python Package Index:
https://pypi.org/project/PedalPi-WebService
License:
Apache License 2.0

Use

Installation and dependencies

Most dependencies will be installed through pip

pip install PedalPi-WebService

WebService, for its publication in the network for auto discover, needs the installation of pybonjour-python3. On debian/ubuntu-based systems, run:

sudo apt-get install libavahi-compat-libdnssd1
pip3 install git+https://github.com/depl0y/pybonjour-python3

Configuring the component

PedalPi components enable the extension of Pedal Pi - Application. Through them, opening services are offered. A list of components can be found in the Components repository.

To use this component, two steps are required:

1. Registering the webservice in Application

The registration must occur before application initialization (application.start)

from application.application import Application
application = Application(path_data="data/", address='localhost')

from webservice.webservice import WebService
application.register(WebService(application, port))

2. Initialization of the web server

The Application documentation suggests using signal.pause so that the program does not terminate at the end of initialization: signal.pause causes the program to be terminated only when it is requested (Ctrl + C).

When we use PedalPi-WebService, we must replace the use of signal.pause by initializing the web server. This is done using the following lines of code:

application.start()

import tornado
try:
    tornado.ioloop.IOLoop.current().start()
except KeyboardInterrupt:
    application.stop()

# Not more necessary
#from signal import pause
#try:
#    pause()
#except KeyboardInterrupt:
#    application.stop()

Config file

The code for starting the Application using the WebService component look like the following code:

from application.application import Application
application = Application(path_data="data/", address='localhost')

from webservice.webservice import WebService
application.register(WebService(application, port))

application.start()

import tornado
tornado.ioloop.IOLoop.current().start()

API

Rest

API documentation can be found at http://pedalpi.github.io/WebService/

WebSocket

Communication via WebService basically consists of receiving updates about the state of the application.

WebService API documentation can be found at http://pedalpi.github.io/WebService/#websocket

Using in your client

WebService disposes the Application features in a web service. These projects uses it for control:

  • Apk: App controller for smart devices and navigators.

If you are using too, please, send a pull request for this project.

Maintenance

Documentation

# Installing dependencies
npm install -g aglio

# Generate doc
cd docs/
aglio -i documentation.apib --theme-variables streak --theme-template triple -o index.html

# View documentation
firefox index.html

Test

# if number != 0 error
sh -c 'coverage3 run --source=webservice wstest/config.py test'; echo $?

coverage3 run --source=webservice wstest/config.py test
coverage3 report
coverage3 html
firefox htmlcov/index.html

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
PedalPi-WebService-0.3.0.tar.gz (17.4 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page