andRoc Introduction & Setup

Content → Mobile Clients → andRoc

• Introduction | Devices | Development
  • External symbols

The Android based wireless client for Rocrail

This is an exclusive goody to supporters of the project, who have a valid Support Key installed.

Android Market QR-Code

andRoc is a goody for those who have a valid support key installed on the server:

• Support Key

andRoc will run 5 minutes after connecting to a Rocrail server without a support key. After those 5 minutes andRoc will shutdown without warning.

(Based on the latest release.)

• Works with all Command Stations supported by Rocrail
• List up all available Rocrail servers. (Android 1.6+)
• Loco/Car throttle with:
  • Loco images
  • Loco image cache to reduce startup.
  • 28 functions in 5 groups and lights
  • Release and Start
  • Emergency Break.
  • Consist management.
  • Train categories
• Loco Setup:
  • Vmin, Vmid and Vmax
  • Programming on the main. (PoM)
  • Dispatch for LocoNet Throttle
• Controls:
  • Automatic mode
  • Routes
  • Actions
  • Switches
  • Outputs
  • System
• Accessory pad
• System monitor
• Layout:
  • List with all ZLevels
  • Block status color
  • Interactive
  • Fiddle Yard
  • Turntable, Traverser
  • Staging block
  • Module view
  • Zoom-able
  • Selectable background color
  • Shows active routes and occupancy
  • Text and Images
• User interface is localized; Depending of the language selected for the device.
• Shows device ID in the Rocview as throttle ID
• Guest Loco setup.

• http://bazaar.launchpad.net/~rocrail-project/rocrail/androc/changes

• An up to date Rocrail installation.
• A valid support key installed on the Rocrail server. (It's a goody for those supporting the project, see top of page.)
• Android 1.6+ based wireless device. (Android 1.5 can also be used without R2RNet support.)
• WLAN (WiFi)
• Preferred are small loco images; normal sized will be down scaled to 50 pixels high.
• Connects to the client port of the Rocrail server.

• https://play.google.com/store/apps/details?id=net.rocrail.androc

This method is preferred; You will be notified about updates, and crash reporting is supported.

1. Search for andRoc or Rocrail in the Market.
2. Touch the install button.
3. Ready to run.

• https://launchpad.net/rocrail/+download

To test andRoc without a local running layout you can use the following demo access:

It has a small layout, connected to the virtual command station, and about 20 predefined locos with small images.

andRoc will use the selected device language if available. It defaults to English.

Add or edit your own language at LaunchPad:
Translations at LaunchPad: https://translations.launchpad.net/rocrail/androc/+pots/androc

Reporting at LaunchPad: https://bugs.launchpad.net/rocrail/androc

Navigation between the activities is done by the Menu.
Touching the Loco image will cycle through the Throttle, Loco and Loco Setup activity.

The initial values are for the Rocrail demo, rocrail.dyndns.org:8051, which needs Internet access of the Android device.
After connecting the Rocrail server a dialog shows the progress of loading the plan.
The last host:port combination is saved for the next session.

The plan title of the Rocrail server which did announce itself over R2RNet.

The IP address or computer name of the target Rocrail server.

The client port of the Rocrail server. Default 8051.

Select one of the previous connected Rocrail server from the list.

This option needs a restart of andRoc to get active.
Use this option with care because this requires a lot of processing power on small devices and can block the user interface of andRoc.
Leave it off for normal use.

Prevent the device of going into sleep mode.

Switch directly to module view in case the loaded plan is modular.

Option for large displays to keep the throttle dialog small.

Load only loco images as needed to decrease communication at startup.

Sort loco list by address instead of ID.

(331+)
This list divides all locos in 5 categories:

1. Steam
2. Diesel
3. Electric
4. Trainset: Independent from engine type if commuter flag is set.
5. Special: Cleaning or Post type.

Use power off instead of emergency break.

Enable throttle speed update. Disable in case of a slow network to avoid slider jumping.

Enable the zoom tool in the layout activity.

Option for decoders with 127/128 speed steps to set the slider resolution 1:1.

Use buttons instead of speed slider. Auto repeat after 1 second.

If not using all speed steps this number is used for in- and decreasing the speed.

Clear the list of recently connected Rocrail servers.

If a Rocrail server has R2RNet activated it will provide its client connection information by multi casting to the andRoc clients.

andRoc:  <netreq req="clientconn"/>
Rocrail: <netrsp host="192.168.100.37" port="8051" rsp="clientconn" plan="Plan-F"/>

Add a → Guest Loco by address.
The new guest loco will appear in the loco category "Special".

Menu	Guest Loco Dialog

The default is DCC and 128 speed steps if only the address is set. In this case the loco ID will be the same as the address.

Note: For all attributes, except Address, is a Rocrail server needed with revision 4559+.

A short touch on the loco image will open the Loco list for selecting.
A long touch on the loco image will open the Loco activity.

Start automatically running the selected loco if the auto mode is activated.
This button is disabled if the auto mode is not activated.

Release a loco from this throttle.
Without releasing a loco from a throttle it is not possible to control it by another throttle/client. This behavior can be manipulated by disable steal loco control.
A long click will send a power off command.

Function group selection button. There are four groups of 6 function buttons available.
A long click will send an emergency break.

A long click will select throttle 1-6.

Toggle the locomotive lights on/off.
A long click will dispatch the selected locomotive for use with a Fred.

Flips the current driving direction of the loco and shows the current speed.
A long click will activate the Consist management.

Velocity commands are send if the delta is 5 or at move end.
The delta is introduced to reduce the amount of commands triggered by changing the bar position.

Start automatically running the selected loco if the auto mode is activated.
The selected schedule is used as destination if set.
On long click the selected block is set as destination. (Fixed in 405.)

Determines if the Start will issue a normal GO or one in half automatic mode.

Moves the loco in the selected block.

Swap the logical placing of the loco.

View, add and remove consist members:

Throttle	Consist management	Consist view	Loco control	Slave shows master

Activated by a long click on the direction button.
A long click on the direction button will switch to the master of the consist if the selected loco is already a consist member.
Selecting a loco from the view list will open the loco control which can be used to swap the placing.

Adjust the velocity in all running modes including automatic.

Programming on the main. PoM
Reading CV value from the main needs bidirectional communication.

Dispatch the loco for a throttle like the LocoNet Fred(i).

This is for testing of accessories.
Especially of use at starting up a new layout in Rocrail.

The addressing scheme can be selected with the Type button:

• M → Module
• F → Flat
• P → Port

For more information on addressing schemes: Addressing

Selecting a start address can be done with the numeric touch field or those four buttons on the bottom of this view.

On power down a notification is shown. The system activity will get visible if this notification is touched.

System events and CS messages are listed up below the buttons of this view.
The max. list length is 100, the oldest entry will be removed from the list.

Start all trains in automatic mode.

Selecting a route will send an activation command to the Rocrail server.
This is mainly used for testing.

Selecting an action will send an unconditional activation command to the Rocrail server.
This is mainly used for testing.

Information about Copyright, license, Version, Throttle ID and so on are listed up on this view.

A list of all available ZLevels.
The example shows all module names of a modular layout.
This list will not appear when only one ZLevel is defined for the current layout.
The first entry in the list is the “modview” visualization if the plan is a modular layout.

A single touch on an object will send for most types a Flip command to the Rocrail server.
Block, FiddleYard and Turntable objects will send an Open or Close command.

A long click and release on an empty spot will activate the zoom tool.

A single touch on the block will open a new view for controlling it.
Long pressing on an occupied block will open the loco control.

Clicking the loco will open the loco list. Selecting a loco from the list will set it in this block.
A long click opens the loco control.
Touching the loco image will also open the loco activity.

Set the block to the Open or Closed state. The LED signals if the block is Open.

Accept a BiDi Ident from a loco in auto mode.
See also: Accept Ident

Touching the FY will open a new view for controlling it.

Opens or closes this fiddle yard for trains.

Move the table to the next/previous track.

Move to the selected track.

Touching the TT will open a new view for controlling it.

Opens or closes this turntable for locomotives.

Move the bridge to the next/previous track.

Move to the selected track.

Check the plan if it is XML well formed with a tool like "XmlSpy".
Or use the W3C service: http://validator.w3.org/#validate_by_upload
Rocrail and Rocview are using the Rocs parser which is not so strict as the Java one.

The Loco images and function icons are stored locally on the SD card. (”/sdcard/androc/”)
They must be deleted manually in case new versions are provided by the Rocrail server.

Imagenames are case sensitive under Android.

Every program has potential problems. To solve them it is of great help if you report the crash using the Google facility which automatically will popup after a crash occurred. This report contains exact information of the crash and makes it very easy for developers to solve and publish a fix.

If your mobile device does not offer “Google Play” you can report it in the Rocrail andRoc Forum with following information:

1. andRoc version.
2. Rocrail version.
3. A step by step description on how to reproduce the crash.
4. Attach the plan.xml from the server you connected andRoc with.
5. Device brand and type.