A python implementation inspired from ICSim. Currently supports running on a single interface "vcan0" and fixed arbitration IDs for the actions including, turn indicators, door lock unlock indicators and speedometer.
The simulator runs in browser with control buttons for the user to interact.
Developed with ❤️ by INE
- Python 3
- Docker
- Linux machine
- Docker (for installing docker on linux)
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh
Further instructions here
Step 1. Clone the repo and navigate into the directory
git clone https://github.com/ine-labs/GearGoat.git
cd GearGoatStep 2. Inside the repository directory, run the following to install required utilities and build the docker container.
sudo chmod +x initial_setup.sh
sudo ./initial_setup.shStep 3. Setup the vcan0 interface
sudo chmod +x vcan_setup.sh
sudo ./vcan_setup.shIf you face any trouble with the above script related to setting up "vcan0" interface, try running this command:
sudo apt-get install -y linux-modules-extra-$(uname -r)Step 4. Run the docker container
sudo docker run --network="host" --privileged geargoatStep 5. The web UI can be accessed at port 80 of the machine in which the container is running.
http://localhost or http://<the_machine_ip>
ip_address=$(hostname -I | awk '{print $1}')
url="http://$ip_address"
echo $urlThere are mainly three car actions that can be performed with this web UI, which includes:
- Toggling turn signals
- Locking/Unlocking Doors
- Updating the speedometer.
Try out each buttons and observe the actions in the UI.
Clicking on indicator buttons switches the state for a fraction of second. The color changes to "orange". Click for a slightly longer duration to register the signal change.
The door is initially locked indicated by "red". It can be unlocked by clicking the corresponding door unlock button which turns the indicator to "green". Clicking the corresponding door lock button again will revert it back to "red".
Finally the accelerate button, which will respond towards mouse clicks. Clicking and holding the button (mousedown) will result in speed increase and releasing the button(mouseup) results in speed falling down.
All these actions generate corresponding CAN packets.
After usage, you can turn off the simulator by:
CONTAINER_ID=$(sudo docker ps -qf "ancestor=geargoat")
sudo docker stop $CONTAINER_IDThe manuals are available in the manuals directory.
The videos associated with the manuals can be accessed at: https://www.youtube.com/playlist?list=PLz6wD_rVyKMAHoVv4J0O0AlO00uSBinDv
Pranjal Soni, Software Engineer (Cloud), INE psoni@ine.com (Primary Contributor)
Nishant Sharma, Director (Lab Platform), INE nsharma@ine.com (Guidance)
Sanjeev Mahunta, Software Engineer (Cloud), INE smahunta@ine.com
- Contributions in the form of code improvements, feature additions, and any general suggestions are welcome.
- The source code can be found inside
container\