Class VehicleGroup

constructor

• new VehicleGroup(mx10): VehicleGroup

• Parameters

  • mx10: MX10

  Returns VehicleGroup

ReadonlyonCallFunction

ReadonlyonCallSpecialFunction

ReadonlyonVehicleLastCtl

ReadonlyonVehicleMode

ReadonlyonVehicleSpeed

ReadonlyonVehicleState

activeModeTakeOver

• activeModeTakeOver(vehicleAddress): void

• Parameters

  • vehicleAddress: number

  Returns void

activeModeTrain

• activeModeTrain(vehicleAddress): void

• Parameters

  • vehicleAddress: number

  Returns void

callFunction

• callFunction(vehicleAddress, functionId, functionStatus): void

• Parameters

  • vehicleAddress: number
  • functionId: number
  • functionStatus: boolean

  Returns void

changeSpeed

• changeSpeed(vehicleAddress, speedStep, forward, eastWest?, emergencyStop?): void

• Parameters

  • vehicleAddress: number
  • speedStep: number
  • forward: boolean
  • OptionaleastWest: Direction
  • OptionalemergencyStop: boolean

  Returns void

getLastController

• getLastController(locoNid, type?): Promise<undefined | MsgVehicleLastCtl>

• Parameters

  • locoNid: number
  • type: number = 1

  Returns Promise<undefined | MsgVehicleLastCtl>

getMode

• getMode(trainNid): Promise<undefined | MsgVehicleMode>

• Parameters

  • trainNid: number

  Returns Promise<undefined | MsgVehicleMode>

getSpecialFx

• getSpecialFx(nid, sfxNr): Promise<undefined | MsgSpecialFx>

• Parameters

  • nid: number
  • sfxNr: SpecialFxNr

  Returns Promise<undefined | MsgSpecialFx>

getSpeed

• getSpeed(trainNid): Promise<undefined | MsgVehicleSpeed>

• Parameters

  • trainNid: number

  Returns Promise<undefined | MsgVehicleSpeed>

getState

• getState(nid): Promise<undefined | MsgVehicleState>

• Parameters

  • nid: number

  Returns Promise<undefined | MsgVehicleState>

parse

• parse(size, command, mode, nid, buffer): void

• Parameters

  • size: number
  • command: number
  • mode: number
  • nid: number
  • buffer: Buffer

  Returns void

setMode

• setMode(trainNid, opMode, speedSteps): Promise<undefined | MsgVehicleMode>

• Parameters

  • trainNid: number
  • opMode: OperatingMode
  • speedSteps: MaxSpeedSteps

  Returns Promise<undefined | MsgVehicleMode>

setSpecialFx

• setSpecialFx(nid, sfxNr, state): Promise<undefined | MsgSpecialFx>

• Parameters

  • nid: number
  • sfxNr: SpecialFxNr
  • state: number

  Returns Promise<undefined | MsgSpecialFx>

setSpeed

• setSpeed(trainNid, speedStep, divisor?, forward?, emergencyStop?, eastWest?): Promise<undefined | MsgVehicleSpeed>

• Parameters

  • trainNid: number
  • speedStep: number
  • divisor: number = 0
  • forward: boolean = true
  • emergencyStop: boolean = false
  • eastWest: Direction = Direction.UNDEFINED

  Returns Promise<undefined | MsgVehicleSpeed>