cloudthrottle / dcc-ex--commands

Javascript command library for DCC++ EX Command Station
https://commands.cloudthrottle.app/
MIT License
5 stars 0 forks source link

DCC++ EX Command Library

A Javascript library to help create DCC++ EX Command strings.

A developer friendly approach to creating command strings that can be sent to a DCC++EX Command Station

Usage/Examples

Quick Start

<script type="module">
    import * as DCCCommands from 'https://cdn.skypack.dev/@cloudthrottle/dcc-ex--commands';

    console.log(DCCCommands.powerCommand({power: 1, track: "MAIN"}));
    // <1 MAIN>
</script>

NPM Package

Install with npm

  npm install @cloudthrottle/dcc-ex--commands
import {throttleCommand} from "@cloudthrottle/dcc-ex--commands";

const commandString = throttleCommand({
    cab: 22,
    speed: 126,
    direction: 1
})

console.log(commandString)
// <t 1 22 126 1>

Demo

Try out some commands

Documentation

Developing

Clone the project

  git clone https://github.com/cloudthrottle/dcc-ex--commands.git

Go to the project directory

  cd dcc-ex--commands

Install environment. This project requires Node v16.8 or above. If node is already installed this step can be skipped. asdf is recommended due to it's simplicity

  asdf install

Install dependencies

  npm install

Run the test suite

  npm test

Related

Here are some related projects