The up-simulator is a user-friendly web tool designed to make developing uProtocol services and Apps on PCs easy. Its intuitive interface empowers users with features such as Publish-Subscribe, RPC invocation, and the simulation of COVESA Vehicle Services. With a focus on a user-friendly graphical interface (GUI), users can easily navigate through the development and testing phases of uProtocol Apps, ensuring a smooth experience from start to finish.
-
SimUI :
The SimUI is a web-based interface for the up-simulator. It displays the list of vehicle services, RPC, and messages defined in COVESA protos. It offers an interface for initiating pub/sub and RPC transactions using mock services.
-
Mock Services :
These mock COVESA services replicate the interface outlined in the COVESA protobuf, offering a seamless alternative to actual COVESA services. By utilizing these mocks, developers can engage in development and testing activities without the necessity of physical COVESA hardware, thereby elevating the development environment.
-
Logger :
The Logger component captures all pub/sub and RPC transactions between mock services and apps/services under development. It facilitates real-time monitoring and logging. Developers can monitor transactions in real-time, aiding in debugging and issue resolution.
Before proceeding with the setup of this project, ensure that the following prerequisites are met:
-
Maven is installed and configured in your environment. You can verify this by running the following command in your terminal:
mvn -version
If Maven is properly installed, you should see information about the Maven version and configuration.
-
Ensure your android emulator is running, and both the
up-core-androidandup-simulator-proxycomponents are up and running. These components are essential for the functionality of this project. Please refer to the installation instructionsup-core-androidandup-simulator-proxy -
When starting the simulator proxy, if you observe the 'Simulator proxy client connected' logs, it indicates that your setup is correct, and the simulator proxy has successfully bound to the
up-core-android.
-
Perform ADB port forwarding to enable communication with the simulator:
adb forward tcp:6095 tcp:6095
This step is essential for establishing a connection between the emulator and the simulator.
-
Start the Zenoh router before running the simulator. You can start the Zenoh router by following the instructions provided in the Zenoh documentation. Once your Zenoh router is started, you will see the following logs
To set up the simulator, follow the steps below:
-
Clone the code from the GitHub repository:
git clone https://github.com/eclipse-uprotocol/up-simulator.git cd up-simulator -
Install the required dependencies using pip:
python3 -m pip install -r requirements.txt -
Execute the
setup_simulator.pyscript using the following command:python3 setup_simulator.py
This script automates the following tasks:
-
Cloning and Compilation of Protos: Clones the
covesaprotos from the specified repository URL, compiles them, and generates Python protofiles in the simulator/target folder. -
Resource Catalog Generation: Iterates through all protofiles to create a resource catalog in the target folder.
-
Services Configuration File Generation: Iterates through the protos again to generate a
services.jsonfile. This file is responsible for the UI of the simulator. At runtime, it parses the JSON to retrieve a list of services, RPC, and messages, and displays them in the UI.
Running this script will generate all the necessary files required for the simulator to function.
To start and use the up-simulator, follow the steps below:
-
Execute the following command to start the simulator:
python3 simulator/run.py -
On the uP Simulator web interface, you will see a dropdown to select the uP client. Currently, it supports Android and Zenoh clients. You can choose either one.
-
Android
-
Zenoh
You need to set the Zenoh router’s IP address and port number.
-
-
To use the publish and subscribe functionality, click on the "Publish-Subscribe" menu. Within this menu, you will find a list of Covesa services.
-
Choose the service you want to test for either subscribing or publishing. You can scroll through the list or use the search box to find your service. Once you’ve selected the service, the simulator will display a list of all supported messages.
-
Choose the specific message for which you want to test both subscribing or publishing
-
Click on the "Subscribe" button to listen for the message data.
-
Select the values you want to publish.
-
Click on the "Publish" button to send the selected values.
-
To test RPC, go to the mock service page, and start the mock service you wish to use for triggering the RPC request.
-
To initiate an RPC request, navigate to the "Remote Procedure Calls" menu. Within this menu, you’ll find a list of Covesa services. Select the particular service you wish to test. Once the service is chosen, a list of available RPCs for that specific service will be displayed. From this list, choose the specific RPC you intend to test.
-
Provide your input and click on the "Send RPC" button.
-
You can now see the RPC request, response and publish, subscribe logs in the logger screen.
-
The script assumes that Python is installed on your system.
-
The
requirements.txtfile contains a list of dependencies that will be installed using pip. -
The simulator is designed to be independent of the specific up client configuration during the setup phase.
Feel free to explore and contribute to the development of the up-simulator!
|
Note
|
This project is currently under development, and further enhancements and features are expected in future. |