Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 2.28 KB

README.md

File metadata and controls

65 lines (41 loc) · 2.28 KB
Raw

Butter MAS Javascript API

HTTP client javascript API for Butter MAS platform.

licence npm

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installation

npm install @butter-robotics/mas-javascript-api

Usage

import { HttpClient } from '@butter-robotics/mas-javascript-api';

const butterHttpClient = new HttpClient('192.168.0.111');  // use your robot ip here

butterHttpClient.playAnimation('jump').then(response => console.log(response.data));

Documentation

  • 👨🏼‍💻 API

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Coding style & tests

Linting

Please lint your contribution before submitting a PR.

npm run lint

Tests

Please test your contribution before submitting a PR.

npm run test

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Benny Megidish

See also the list of contributors who participated in this project.

License

This project is licensed under the Apache 2.0 License - see the LICENSE.md file for details