helyOS-JavaScript-SDK

About The Project

The helyosjs-sdk allows the development of javascript applications using the helyOS framework. This library contains all necessary methods and entity types to build a front-end using helyOS as backend system.

List of features

• Log in as administrator or regular user.
• List and edit automatons (tools).
• Retrieve sensors data and work process status.
• Create, schedule and handle work processes.
• Manage and edit yards: set drivable areas and obstacles.

Built With

• Typescript
• Apollo
• Socket.io

Getting Started

Installation

$ npm i helyosjs-sdk  --save

Usage

import { HelyosServices, H_Tools  } from 'helyosjs-sdk';

const helyosService = new HelyosServices('http://localhost', {socketPort:'5002', gqlPort:'5000'});

const username = 'admin@email.com';
const password = 'password';

 helyosService.login(username, password)
.then( response => helyosService.connect())
.then( connected => console.log(connected));;

function listTools {
    return helyosService.tools.list(0)
    .then((tools: H_Tools[]) => {
        console.log(tools);
    });
}

function editTool(patch: H_Tools) {
    return helyosService.tools.patch(patch)
    .then(tool => {
        console.log(tool);
    )}
}

Listening agent/tool sensors and work process status

helyosService.connect()
.then(() => {
            const socket = helyosService.socket;

            socket.on('new_tool_poses',(updates)=>{
                console.log(updates);  // Notifications from tool sensors.
            });

            socket.on('change_tool_status',(updates)=>{
                console.log(updates);  // Notifications from tools working status.
            });

            socket.on('change_work_processes',(updates)=>{
                console.log(updates);  // Notifications from work processes status.
            });
});

Command Reference

Command	Description
helyosService.register(email,password,adminPassword): Promise	Register new user.
helyosService.login(username, password): Promise	User login.
helyosService.connect(): Promise	Establish websocket connection after logged.
helyosService.logout(): Promise	User logout.
helyosService.changePassword(user,password,newPassword): Promise	Change password.
---	---
EXAMPLE OF CRUD OPERATIONS
helyosService.workprocess	Work Processes services
.list (condition: Partial): Promise<H_WorkProcess[]>	list all work processes filtered by condition.
.create (data: H_WorkProcess): Promise	create work process.
.get (workProcessId: number): Promise	get work process by ID.
.patch (data:Partial): Promise	edit work process.
---	---

Most important models

Model	Description
H_Tools	Tool represents any movable device that can perform an action
id: number	unique db identifcation number
code: number	unique identifcation number
name: string	tool name
picture: string	base64 jpg
yardId: number	to which yard this tool is associated.
status: string	'busy', 'free'
picture: string	base64 jpg
geometry: JSON	Description of the tool geometry
heartbeat: Date	Last time tool contacted the yard base
---	---
H_Yard	Physical space enclosing tools in a drivable area.
id: number	unique db identifcation number
name: string	yard name
picture: string	base64 jpg
mapData: {origin: {lat?: number, lon?: number, zoomLevel?: number}}	base64 jpg
---	---
H_Shape	Define drivable areas or obstacles inside the yard.
id: number	unique db identifcation number.
yardId: number	associated yard.
deletedAt: Date	when shape was marked deleted.
geometry: {top: number, bottom: number, points: number[][]}	shape of extruded polygon
---	---
H_WorkProcess	Group and serialize actions to be executed by the tools.
id: number	unique db identifcation number.
schedStartAt: date	date and time when the process is scheduled to start.
schedEndAt: date	date and time when the process is predicted to end.
startedAt: date	date and time of actual start.
endedAt: date	date and time of actual end.
status: string	status.
processType: string	status.
data: MoveToTargetDescriptor | MoveFreeDescription	Any JSON data that describes the actions.
---	---
H_Target	Reference positions in the yard used by the worked process
id: number	unique db identifcation number.
yardId: number	associated yard.
targetName: string	name of target.
targetType: string	type of target.
x: number	horizontal distance from yard origin (milimeters).
y: number	vertical distance from yard origin (milimeters).
orientation: number	target orientation angle (mili radians).
---	---

Contributing

Keep it simple. Keep it minimal.

Authors

• Carlos E. Viol Barbosa
• Nikolay Belov

License

This project is licensed under the MIT License