Part 2 robot simulator

[JoelChanZhiYang]

Description

The EV3 robot simulator implementation is in PR. This looks like a big PR but about half of it is tests.

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How Has This Been Tested?

There is 119 tests to test the main aspects of the robot simulation.

To try out the robot simulation. You can try out this snippet.

In this snippet, you will observe

• Wheels
• Motors
• Paper and url loading
• Ultrasonic sensor
• ev3_pause
• Floor and Wall

import {
  ev3_motorA,
  ev3_motorB,
  ev3_motorC,
  ev3_motorD,
  ev3_runToRelativePosition,
  ev3_colorSensorRed,
  ev3_colorSensorGreen,
  ev3_pause,
  ev3_colorSensorBlue,
  ev3_ultrasonicSensor,
  ev3_ultrasonicSensorDistance,
  init_simulation,
  createRenderer,
  createPhysics,
  createTimer,
  createWorld,
  createPaper,
  createWall,
  createEv3,
  createFloor,
  createCSE,
  createRobotConsole,
  addControllerToWorld,
  saveToContext
} from "robot_simulation";


init_simulation(() => {
    const physics = createPhysics();
    const renderer = createRenderer();
    const timer = createTimer();
    const robot_console = createRobotConsole();
    
    const world = createWorld(physics, renderer, timer, robot_console);
    
    const program = createCSE();
    addControllerToWorld(program, world);
    
    const paper = createPaper(
        renderer, 
        "https://www.shutterstock.com/image-vector/black-white-stripes-260nw-785326606.jpg", 
        1, 
        1);
        
    addControllerToWorld(paper, world);
    
    const floor = createFloor(physics, renderer);
    addControllerToWorld(floor, world);
    
    const wall = createWall(physics, renderer);
    addControllerToWorld(wall, world);
    
    const ev3 = createEv3(physics, renderer);
    addControllerToWorld(ev3, world);
    
    saveToContext("world", world);
    saveToContext("ev3", ev3);
    
    return world;
});

// Student code below

let motorA = ev3_motorA();
let motorB = ev3_motorB();
let ultrasonicSensor = ev3_ultrasonicSensor();

ev3_pause(2000);

let loop = true;

while (loop) {
    let distance = ev3_ultrasonicSensorDistance(ultrasonicSensor);
    
    if (distance < 50) {
        loop = false;
        continue;
    }
    
    ev3_runToRelativePosition(motorA, 360, 200);
    ev3_runToRelativePosition(motorB, 360, 200);
    ev3_pause(3000);
}

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

[RichDom2185]

Hi, thanks for working on this! Very excited to try it out; have not looked through all the files but in the meantime, here are some preliminary comments:

[RichDom2185]

Hi, sorry for the delayed review, thanks a lot for working on this! LGTM, though I just have a few minor comments; would kindly ask if you could reply to them.

Thanks and it looks really good too! 🤩

[RichDom2185]

Are we going to eventually move this into a/the repo?

[JoelChanZhiYang]

Hello! Sorry for the slow reply!

How do other modules host their static files? Is it inside the modules repo or in a separate repo?

[RichDom2185]

So far I think the only other module with static assets is unity academy, and we host the files in an S3 bucket on AWS

[JoelChanZhiYang]

Ah alright. How do I go about to do that?

[RichDom2185]

Let's take this over to Telegram.

[RichDom2185]

Ditto.

[RichDom2185]

Is this unused variable intentional?