@hat-core/juggler NPM

Hat Core - remote control and monitoring framework core

Hat Open is open-source framework of tools and libraries for developing applications used for remote monitoring, control and management of intelligent electronic devices such as IoT devices, PLCs, industrial automation or home automation systems.

Hat Core is part of Hat Open providing collection of components and libraries on which Hat Open system is based.

Development of Hat Open and associated repositories is sponsored by Končar - Power Plant and Electric Traction Engineering Inc. (Končar KET

https://www.koncar-ket.hr).

For more information see:

Hat Open homepage - in development
Hat Core homepage - https://core.hat-open.com
Hat Core documentation - https://core.hat-open.com/docs
Hat Core git repository - https://github.com/hat-open/hat-core.git
Hat Core issues - https://github.com/hat-open/hat-core/issues

::: {.warning} ::: {.title} Warning :::

This project is currently in state of active development. Features, functionality and API are unstable. :::

Installation

Hat Open consists of multiple interconnected parts. Each part implements a specific functionality. For easier reusability, provided implementation is split into multiple packages:

Python packages

Python packages require Python 3.8 and can be installed with `pip`:

$ pip install <package-name>

where package-name is one of following:

hat-util
Utility module
hat-peg
Parsing expression grammar
hat-sbs
Chatter communication protocol
hat-chatter
Simple binary serialization
hat-juggler
Juggler communication protocol
hat-duktape
Python Duktape JS wrapper
hat-sqlite3
Hat specific sqlite3 build
hat-asn1
ASN.1 parser and encoder
hat-drivers
Communication drivers
hat-orchestrator
Simple cross-platform daemon/service manager
hat-monitor
Redundancy and service discovery server
hat-event
Event pub/sub communication and storage
hat-gateway
Remote communication device gateway
hat-gui
GUI server
hat-translator
Configuration transformation interface
hat-syslog
Syslog server and logging handler

JavaScript packages

JavaScript packages can be installed with `npm`:

$ npm install <package-name>

where package-name is one of following:

\@hat-core/util
Utility module
\@hat-core/renderer
Virtual DOM renderer
\@hat-core/future
Async Future implementation
\@hat-core/juggler
Juggler client library

Build

Build tool used for Hat is pydoit (http://pydoit.org/{.title-ref}). It can be installed with pip{.title-ref} by running:

$ pip install doit

For listing available doit tasks, use:

$ doit list

Default task:

$ doit

creates dist{.title-ref} folder containing built packages.

Dependencies

Package managers used for managing dependencies:

pacman
Package manager of Arch linux distribution. Available on Windows as part of msys2{.title-ref} (http://www.msys2.org/).
pip
Package manager available as part of CPython installation.
yarn
Package manager for NodeJS.

List of all dependencies for building and running hat components is available in: