Giter VIP home page Giter VIP logo

railmind-api's Introduction

RailMinds API

RailMinds API is a RESTful interface for controlling model trains and accessories. It provides endpoints to manage train speeds, directions, and accessory activation.

API Documentation

Get a list of available trains

GET /trains

Retrieve a list of available trains.

Set the speed of a specific train

PUT /trains/{trainId}/speed?speed=50

Set the speed of a specific train identified by {trainId}. The speed parameter should be a value between 0 and 100.

Change the direction of a specific train

PUT /trains/{trainId}/direction?direction=forward

Change the direction of a specific train identified by {trainId}. The direction parameter should be either "forward" or "reverse".

Get a list of available accessories

GET /accessories

Retrieve a list of available accessories.

Activate a specific accessory

PUT /accessories/{accessoryId}/activate

Activate a specific accessory identified by {accessoryId}.

Deactivate a specific accessory

PUT /accessories/{accessoryId}/deactivate

Deactivate a specific accessory identified by {accessoryId}.

Example Usage

curl -X PUT http://api.example.com/trains/1/speed?speed=75 \
  -H "Content-Type: application/json" \
  -d '{"speed": 75}'

This example sets the speed of the train with ID 1 to 75.

This diagram represents the basic interactions with the RailMinds API

railmind-api's People

Contributors

bunchc avatar

Watchers

 avatar

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.