Giter Club home page Giter Club logo

automaton-core's Introduction

automaton-core

โš ๏ธ This is a Work In Progress (WIP)

automaton-core is a TypeScript Wrapper for IOT/automaton/robot projects. It aims to provide an easy way to communicate with an external controller, so you can focus on what's important: behavior.

Example

// index.ts
import { BareConfig, AutomatonCore, SerialPortConnector, WebSocketConnector } from 'automaton-core';

import { Automaton } from './automaton';

const config: BareConfig = {
  id: 'main-automaton',
  connectors: [
    // {
    //   type: 'serial',
    //   options: {
    //     path: '/dev/ttyAMA0',
    //   },
    // },
    {
      type: 'websocket',
      options: {
        address: 'ws://localhost:3000',
      },
    },
  ],
};

function main() {
  const automaton = new AutomatonCore({
    config,
    connectors: {
      [SerialPortConnector.type]: SerialPortConnector.creator,
      [WebSocketConnector.type]: WebSocketConnector.creator,
    },
    behavior: (write, config, logger) => {
      return new Automaton(write, config, logger);
    },
  });

  automaton.start();
}

main();
// automaton.ts
import { AutomatonBehavior, ActionType, BareConfig, ILogger, WriteAction } from 'automaton-core';

export class Automaton implements AutomatonBehavior {
  constructor(private write: WriteAction, private config: BareConfig, private logger: ILogger) {}

  handle(action: ActionType) {
    this.logger.log('received action', { action });
    this.write({
      type: 'hello',
    });
  }

  start() {
    this.logger.log('Started automaton!', this.config);
  }

  stop() {
    this.logger.log('Stopped automaton!');
    return Promise.resolve();
  }
}

Todo

  • Complete documentation + a dd examples
  • Create controller lib (& move them to an org?)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.