Skip to main content

Interface server of the KogniHome project

Project description

A web server and bridge between networks using the Web Application Message Protocol (WAMP) and the Robotic Service Bus (RSB) build upon crossbar. WAMP is provided by autobahn. This software is actively developed as part of the project KogniHome.

Installation

KogniServer can be obtained via pip

$ pip install kogniserver

or cloned and installed from github

$ git clone https://github.com/aleneum/kogniserver.git
$ cd kogniserver
$ python setup.py install (--prefix=/install/path/prefix)
$ # python setup.py install --prefix=/usr/local

/install/path should be the root of your preferred environment and will be concatenated with 'lib/python2.7/site-packages'. Make sure that /install/path/lib/python2.7/site-packages is in your PYTHONPATH.

Configuration and Starting

To configure crossbar you need to create a config.json and tell crossbar where to find it. kogniserver will assist you in creating a file if it cannot find one.

$ kogniserver 
config.json for crossbar does not exists. Should a default one be created? [y]/n:y
Location of proto-files? [/usr/local/share/rst0.12/proto]:/usr/local/share/rst0.12/proto/
No Crossbar.io instance is currently running from node directory /home/foobar/kogniserver.
...

This will create a common config.json at /install/path/etc/crossbar/config.json (e.g. /usr/local/etc...) If you like to use an existing config.json you can use the -c option:

$ kogniserver -c /path/to/your/crossbar/config.json
...

To overwrite an existing config.json at /install/path/etc/crossbar/config.json, start kogniserver with -f:

$ kogniserver -f
Location of proto-files? [/usr/local/share/rst0.12/proto]:
...

Alternatively you can start crossbar and kogniserver individually. First start a crossbar instance:

$ crossbar start --config=/path/to/config.json

After that you can initialize kogniserver:

$ kogniserver -k # --keep-alive; use existing crossbar instance
kogniserver(asyncio) started...

The --keep-alive flag will tell kogniserver to use the running instance. If it is not passed, kogniserver will try to shutdown this instance and start a new one.

If you use the standard configuration, files will be hosted under /install/path/var/www/kogniserver and can be reached via http://localhost:8181.

Ctrl+C or a SIGTERM will exit the server.

What now?

If you plan to write applications in javascript, head over to the KogniJS-Framework.

Acknowledgements

The development of this software was supported through project grants KogniHome (German Federal Ministry of Education and Research (BMBF) grant no. 16SV7054K) at Bielefeld University.

Project details


Download files

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

Source Distribution

kogniserver-0.3.1.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

kogniserver-0.3.1-py2.py3-none-any.whl (14.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file kogniserver-0.3.1.tar.gz.

File metadata

  • Download URL: kogniserver-0.3.1.tar.gz
  • Upload date:
  • Size: 10.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0

File hashes

Hashes for kogniserver-0.3.1.tar.gz
Algorithm Hash digest
SHA256 2127e5bd1f4867ffa7c7f5262ba6e267c8691b805ba2b4051ab7601c5cfc98ac
MD5 22255e8dcf6178ea78140bfce873bfcb
BLAKE2b-256 d42066a6d415c5592d05ffe96b9f593a504b96ed3f6899828356d0bc3f6a5c11

See more details on using hashes here.

File details

Details for the file kogniserver-0.3.1-py2.py3-none-any.whl.

File metadata

  • Download URL: kogniserver-0.3.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 14.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0

File hashes

Hashes for kogniserver-0.3.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 49a3c2a4b04f6a740cbafed484d460c55d8997f8558e896b05d423868f984c4a
MD5 970bf5ed3fc9a1947bb5f1183c37469f
BLAKE2b-256 0703fd89ad22f8b4909cf6cd468bbe29a009b5bbed85bd3c241b93b38a89440e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page