guide.html

<h3>Map</h3>
<p>
  The simulated map is 2362mm by 1143mm; the size of an FLL / WRO field mat.
  If providing a custom image, ensure that it is 2362 x 1143 pixels; each pixel represents 1mm.
  Images of different dimensions should load, but would probably not provide the result you're expecting.
</p>
<p>
  Click on the map to make measurements.
  A second click locks the line in place, and a third click clears the measurement.
</p>
<h3>Robot Configuration</h3>
  <ul>
    <li>OUTPUT B : Left motor</li>
    <li>OUTPUT C : Right motor</li>
    <li>INPUT 1  : Ultrasonic Sensor</li>
    <li>INPUT 2  : Left Color Sensor</li>
    <li>INPUT 3  : Right Color Sensor</li>
    <li>INPUT 4  : Gyro Sensor</li>
  </ul>
<p>All other outputs and inputs are unconnected.</p>
<p>
  Read the <a href="https://python-ev3dev.readthedocs.io/en/latest/index.html">python-ev3dev2 documents</a> for the API documentations.
  Most common APIs are supported, and you can check the following table for details.
</p>
<h3>Supported python-ev3dev2 API</h3>
<table>
  <thead>
    <th>Classes</th>
    <th>Supported</th>
  </thead>
  <tbody>
    <tr>
      <td class="section" colspan=2>Units</td>
    </tr>
    <tr>
      <td>SpeedPercent</td>
      <td>Yes</td>
    </tr>
    <tr>
      <td>SpeedNativeUnits</td>
      <td>Yes</td>
    </tr>
    <tr>
      <td>SpeedRPS</td>
      <td>Yes</td>
    </tr>
    <tr>
      <td>SpeedRPM</td>
      <td>Yes</td>
    </tr>
    <tr>
      <td>SpeedDPS</td>
      <td>Yes</td>
    </tr>
    <tr>
      <td>SpeedDPM</td>
      <td>Yes</td>
    </tr>
    <tr>
      <td class="section" colspan=2>Common Motors</td>
    </tr>
    <tr>
      <td>Motor</td>
      <td>Yes<br>
        - address and driver name not supported<br>
        - State is never ramping, holding, overloaded, or stalled; Only running or blank<br>
        - Stop action is ignored; robot always stops instantly<br>
        - duty cycle behaves the same as speed<br>
        - position and speed PID constants does nothing
      </td>
    </tr>
    <tr>
      <td>LargeMotor</td>
      <td>Yes</td>
    </tr>
    <tr>
      <td class="section" colspan=2>Multiple-motor groups</td>
    </tr>
    <tr>
      <td>MotorSet</td>
      <td>Yes</td>
    </tr>
    <tr>
      <td>MoveTank</td>
      <td>Yes</td>
    </tr>
    <tr>
      <td>MoveSteering</td>
      <td>Yes</td>
    </tr>
    <tr>
      <td class="section" colspan=2>Sensors</td>
    </tr>
    <tr>
      <td>ColorSensor</td>
      <td>Yes<br>
        - ambient_light_intensity will always return 0<br>
        - color and color_name may not give the same value as the actual sensor<br>
        - raw values ranges between 0 to 255<br>
        - calibrate_white does nothing<br>
      </td>
    </tr>
    <tr>
      <td>GyroSensor</td>
      <td>Yes</td>
    </tr>
    <tr>
      <td>UltrasonicSensor</td>
      <td>Yes<br>
        - In an actual ultrasonic sensor, if the angle of incident is too steep, the sound gets reflected away from the sensor resulting in no reading.
        We try to replicate this by providing readings only if the angle of incident is no more than 50 degrees.<br>
        - The slow update rate of an actual ultrasonic sensor is simulated; readings are only updated around 10 times per sec.<br>
        - other_sensor_present will always return False<br>
      </td>
    </tr>

    <tr>
      <td class="section" colspan=2>Sound</td>
    </tr>
    <tr>
      <td>Sound</td>
      <td>Yes<br>
        - speak, play_tone, beep, set_volume, and get_volume are working<br>
        - espeak_opts for speak is ignored<br>
        - args for beep is ignored<br>
      </td>
    </tr>
  </tbody>
</table>