KangarooChannel MethodsKangaroo Library for .NET

The KangarooChannel type exposes the following members.

Methods

  NameDescription
Public methodBaudRate
Sets the baud rate. This affects all channels of the controller that receives the command.
Public methodGet
Issues a 'get' request.
Public methodGetMax
Gets the maximum position. This corresponds to DEScribe's Nominal Travel maximum.
Public methodGetMin
Gets the minimum position. This corresponds to DEScribe's Nominal Travel minimum.
Public methodGetP
Gets the absolute position.
Public methodGetPI
Gets the incremental position (relative to the position when the last command was issued).
Public methodGetS
Gets the absolute speed (positive or negative depending on direction).
Public methodGetSI
Gets the incremental speed (relative to the speed when the last command was issued).
Public methodHome
Homes the channel.
Public methodP
Moves to the specified absolute position. This command is most useful for absolutely-positioned systems.
Public methodPI
Makes an incremental move. This command is useful any time you want to make a motion relative to where you are right now. Rovers are a case where this is almost always what you want.
Public methodPowerDown
Powers down the channel.
Public methodPowerDownAll
Powers down all channels of the controller that receives the command.
Public methodS
Moves at a particular speed.
Public methodSerialTimeout
Sets the serial timeout. This affects all channels of the controller that receives the command.
Public methodSI
Moves at a particular speed, incremental from the current speed. This is useful for cruise control: a negative increment will slow down, a positive increment will speed up, and a zero increment will hold the current speed.
Public methodStart
Starts the channel. Also, the Kangaroo LED will shine brightly for a third of a second.
Public methodSystemCommand
Sends a system command. These are mostly for advanced use cases.
Public methodUnits
Sets custom units for the channel. This command may be called after you start the channel but before you home it. If you do not set custom units, the units you have set up in DEScribe will be used. If you haven't set any, machine units will be used.
Top
See Also

Reference