.. include:: <isonum.txt>

# Programming the Romi

Writing a program for the Romi is very similar to writing a program for a regular FRC\ |reg| or FTC\ |reg| robot. In fact, all the same tools (Visual Studio Code, Driver Station, SmartDashboard, etc) can be used with the Romi.

## Creating a Romi Program

Creating a new program for a Romi is like creating a normal WPILib program, similar to the :doc:`Zero To Robot </docs/zero-to-robot/step-4/index>` programming steps.

WPILib comes with two templates for Romi projects, including one based on TimedRobot, and a Command-Based project template. Additionally, an example project is provided which showcases some of the built-in functionality of the Romi. This article will walk through creating a project from this example.

.. note:: In order to program the Romi using C++, a compatible C++ desktop compiler must be installed. See :ref:`Robot Simulation - Additional C++ Dependency <cpp_sim_additional_dependency>`.

### Creating a New WPILib Romi Project

Bring up the Visual Studio Code command palette with :kbd:`Ctrl+Shift+P`, and type "New project" into the prompt. Select the "Create a new project" command:

.. image:: /docs/software/vscode-overview/images/creating-robot-program/create-new-project.png

This will bring up the "New Project Creator Window". From here, click on "Select a project type (Example or Template), and pick "Example" from the prompt that appears:

.. image:: images/programming-romi/vscode-select-example.png

Select the programming language you want to use:

.. image:: images/programming-romi/vscode-select-language.png

Next, a list of examples will appear. Scroll through the list to find the "RomiReference" example:

.. image:: images/programming-romi/romi-vscode-reference-example.png

Fill out the rest of the fields in the "New Project Creator" and click "Generate Project" to create the new robot project.

### Running a Romi Program

Once the robot project is generated, it is essentially ready to run. The project has a pre-built ``Drivetrain`` class and associated default command that lets you drive the Romi around using a joystick.

One aspect where a Romi project differs from a regular FRC or FTC robot project is that the code is not deployed directly to the Romi. Instead, a Romi project runs on your development computer and leverages the WPILib simulation framework to communicate with the Romi robot.

To run a Romi program, first, ensure that your Romi is powered on. Next, connect to the ``WPILibPi-<number>`` WiFi network broadcast by the Romi. If you changed the Romi network settings (for example, to connect it to your own WiFi network) you may change the IP address that your program uses to connect to the Romi. To do this, open the ``build.gradle`` file and update the ``wpi.sim.envVar`` line to the appropriate IP address.

.. rli:: https://raw.githubusercontent.com/wpilibsuite/vscode-wpilib/v2027.0.0-alpha-6/vscode-wpilib/resources/gradle/javaromi/build.gradle
   :language: groovy
   :lines: 44-47
   :lineno-match:
   :emphasize-lines: 2

Now to start your Romi robot code, open the WPILib Command Palette (type :kbd:`Ctrl+Shift+P`) and select "Simulate Robot Code", or press :kbd:`F5`.

.. image:: images/programming-romi/romi-vscode-simulate.png
   :alt: Launching simulation via the WPILib Command Palette

If all goes well, you should see a line in the console output that reads "HALSimWS: WebSocket Connected":

.. image:: images/programming-romi/romi-vscode-connected.png

Your Romi code is now running!