Skip to content

Commit f2ab16b

Browse files
behrischbehrisch
committed
linking to new python docs #2 
1 parent d53e3e7 commit f2ab16b

45 files changed

Lines changed: 550 additions & 553 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/web/docs/Simulation/Emergency.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Vehicles that are forming a rescue lane will have [generic parameter](GenericPar
4242
Surrounding traffic reacts while within 25m of the device-equipped vehicle. This distance is configurable by:
4343

4444
- the SUMO option [**--device.bluelight.reactiondist**](https://sumo.dlr.de/docs/sumo.html#bluelight_device), or
45-
- the TraCI command [`traci.vehicle.setParameter(vehID, "device.bluelight.reactiondist", str(value))`](https://sumo.dlr.de/pydoc/traci._vehicle.html#VehicleDomain-setParameter)
45+
- the TraCI command [`traci.vehicle.setParameter(vehID, "device.bluelight.reactiondist", str(value))`](https://sumo.dlr.de/pydoc/traci/_vehicle.html#VehicleDomain.setParameter)
4646

4747
## Further Features for driving with special rights
4848

‎docs/web/docs/Simulation/NEMA.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Example: In the above NEMA diagram, we could see phase 1+5, 1+6, 2+6, 3+7, 3+8 a
2323

2424
# Defining New NEMA phase timings
2525

26-
You can load new definitions for NEMA-phase traffic controller as a part of an {{AdditionalFile}}. The signal timing could be updated in simulation through [TraCI functions](https://sumo.dlr.de/pydoc/traci._trafficlight.html#TrafficLightDomain-setNemaOffset). A definition of a traffic light program for a four-leg eight-phase intersection within an {{AdditionalFile}}
26+
You can load new definitions for NEMA-phase traffic controller as a part of an {{AdditionalFile}}. The signal timing could be updated in simulation through [TraCI functions](https://sumo.dlr.de/pydoc/traci/_trafficlight.html#TrafficLightDomain.setNemaOffset). A definition of a traffic light program for a four-leg eight-phase intersection within an {{AdditionalFile}}
2727
looks like this:
2828

2929
```xml

‎docs/web/docs/TraCI/BusStop.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ value is also shown in the table.
1919

2020
| Variable | ValueType | Description | [Python Method](../TraCI/Interfacing_TraCI_from_Python.md) |
2121
| -------------------------------------------- | ------------------- | ----------------- | -------------------------------------------------------------- |
22-
| end pos | double | The end position of the stop along the lane measured in m. | [getEndPos](https://sumo.dlr.de/pydoc/traci._busstop.html#BusStopDomain-getEndPos) |
23-
| lane ID | string | Returns the lane of this calibrator (if it applies to a single lane) | [getLaneID](https://sumo.dlr.de/pydoc/traci._busstop.html#BusStopDomain-getLaneID) |
24-
| name | string | Returns the name of this stop | [getName](https://sumo.dlr.de/pydoc/traci._busstop.html#BusStopDomain-getName) |
25-
| person count | integer | Get the total number of waiting persons at the named bus stop. | [getPersonCount](https://sumo.dlr.de/pydoc/traci._busstop.html#BusStopDomain-getPersonCount) |
26-
| person ID | stringList | Get the IDs of waiting persons at the named bus stop. | [getPersonIDs](https://sumo.dlr.de/pydoc/traci._busstop.html#BusStopDomain-getPersonIDs) |
27-
| start pos | double | The starting position of the stop along the lane measured in m. | [getStartPos](https://sumo.dlr.de/pydoc/traci._busstop.html#BusStopDomain-getStartPos) |
28-
| vehicle count | integer | Get the total number of vehicles stopped at the named bus stop. | [getVehicleCount](https://sumo.dlr.de/pydoc/traci._busstop.html#BusStopDomain-getVehicleCount) |
29-
| vehicle ID | stringList | Get the IDs of vehicles stopped at the named bus stop. |[getVehicleIDs](https://sumo.dlr.de/pydoc/traci._busstop.html#BusStopDomain-getVehicleIDs) |
22+
| end pos | double | The end position of the stop along the lane measured in m. | [getEndPos](https://sumo.dlr.de/pydoc/traci/_busstop.html#BusStopDomain.getEndPos) |
23+
| lane ID | string | Returns the lane of this calibrator (if it applies to a single lane) | [getLaneID](https://sumo.dlr.de/pydoc/traci/_busstop.html#BusStopDomain.getLaneID) |
24+
| name | string | Returns the name of this stop | [getName](https://sumo.dlr.de/pydoc/traci/_busstop.html#BusStopDomain.getName) |
25+
| person count | integer | Get the total number of waiting persons at the named bus stop. | [getPersonCount](https://sumo.dlr.de/pydoc/traci/_busstop.html#BusStopDomain.getPersonCount) |
26+
| person ID | stringList | Get the IDs of waiting persons at the named bus stop. | [getPersonIDs](https://sumo.dlr.de/pydoc/traci/_busstop.html#BusStopDomain.getPersonIDs) |
27+
| start pos | double | The starting position of the stop along the lane measured in m. | [getStartPos](https://sumo.dlr.de/pydoc/traci/_busstop.html#BusStopDomain.getStartPos) |
28+
| vehicle count | integer | Get the total number of vehicles stopped at the named bus stop. | [getVehicleCount](https://sumo.dlr.de/pydoc/traci/_busstop.html#BusStopDomain.getVehicleCount) |
29+
| vehicle ID | stringList | Get the IDs of vehicles stopped at the named bus stop. |[getVehicleIDs](https://sumo.dlr.de/pydoc/traci/_busstop.html#BusStopDomain.getVehicleIDs) |

‎docs/web/docs/TraCI/Calibrator.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,16 @@ value is also shown in the table.
1919

2020
| Variable | ValueType | Description | [Python Method](../TraCI/Interfacing_TraCI_from_Python.md) |
2121
| -------------------------------------------- | ------------------- | ----------------- | -------------------------------------------------------------- |
22-
| begin | double | Returns the begin time of the current calibration interval | [getBegin](https://sumo.dlr.de/pydoc/traci._calibrator.html#CalibratorDomain-getBegin) |
23-
| edge ID | string | Returns the edge of this calibrator | [getEdgeID](https://sumo.dlr.de/pydoc/traci._calibrator.html#CalibratorDomain-getEdgeID) |
24-
| end | double | Returns the end time of the current calibration interval | [getEnd](https://sumo.dlr.de/pydoc/traci._calibrator.html#CalibratorDomain-getEnd) |
25-
| insert | double | Returns the number of inserted vehicles in the current calibration interval | [getInserted](https://sumo.dlr.de/pydoc/traci._calibrator.html#CalibratorDomain-getInserted) |
26-
| lane ID | string | Returns the lane of this calibrator (if it applies to a single lane)| [getLaneID](https://sumo.dlr.de/pydoc/traci._calibrator.html#CalibratorDomain-getLaneID) |
27-
| passed | double | Returns the number of passed vehicles in the current calibration interval | [getPassed](https://sumo.dlr.de/pydoc/traci._calibrator.html#CalibratorDomain-getPassed) |
28-
| removed | double | Returns the number of removed vehicles in the current calibration interval | [getRemoved](https://sumo.dlr.de/pydoc/traci._calibrator.html#CalibratorDomain-getRemoved) |
29-
| route ID | string | Returns the route id for the current calibration interval | [getRouteID](https://sumo.dlr.de/pydoc/traci._calibrator.html#CalibratorDomain-getRouteID) |
30-
| routeProbe ID | double | Returns the routeProbe id for this calibrator | [getRouteProbeID](https://sumo.dlr.de/pydoc/traci._calibrator.html#CalibratorDomain-getRouteProbeID) |
31-
| speed | double | Returns the target speed of the current calibration interval | [getSpeed](https://sumo.dlr.de/pydoc/traci._calibrator.html#CalibratorDomain-getSpeed) |
32-
| type ID | string | Returns the type id for the current calibration interval | [getTypeID](https://sumo.dlr.de/pydoc/traci._calibrator.html#CalibratorDomain-getTypeID) |
33-
| vTypes | string | Returns a list of all types to which the calibrator applies (in a type filter is active) | [getVTypes](https://sumo.dlr.de/pydoc/traci._calibrator.html#CalibratorDomain-getVTypes) |
34-
| vehicle per hour | double | Returns the number of vehicles per hour in the current calibration interval | [getVehsPerHour](https://sumo.dlr.de/pydoc/traci._calibrator.html#CalibratorDomain-getVehsPerHour) |
22+
| begin | double | Returns the begin time of the current calibration interval | [getBegin](https://sumo.dlr.de/pydoc/traci/_calibrator.html#CalibratorDomain.getBegin) |
23+
| edge ID | string | Returns the edge of this calibrator | [getEdgeID](https://sumo.dlr.de/pydoc/traci/_calibrator.html#CalibratorDomain.getEdgeID) |
24+
| end | double | Returns the end time of the current calibration interval | [getEnd](https://sumo.dlr.de/pydoc/traci/_calibrator.html#CalibratorDomain.getEnd) |
25+
| insert | double | Returns the number of inserted vehicles in the current calibration interval | [getInserted](https://sumo.dlr.de/pydoc/traci/_calibrator.html#CalibratorDomain.getInserted) |
26+
| lane ID | string | Returns the lane of this calibrator (if it applies to a single lane)| [getLaneID](https://sumo.dlr.de/pydoc/traci/_calibrator.html#CalibratorDomain.getLaneID) |
27+
| passed | double | Returns the number of passed vehicles in the current calibration interval | [getPassed](https://sumo.dlr.de/pydoc/traci/_calibrator.html#CalibratorDomain.getPassed) |
28+
| removed | double | Returns the number of removed vehicles in the current calibration interval | [getRemoved](https://sumo.dlr.de/pydoc/traci/_calibrator.html#CalibratorDomain.getRemoved) |
29+
| route ID | string | Returns the route id for the current calibration interval | [getRouteID](https://sumo.dlr.de/pydoc/traci/_calibrator.html#CalibratorDomain.getRouteID) |
30+
| routeProbe ID | double | Returns the routeProbe id for this calibrator | [getRouteProbeID](https://sumo.dlr.de/pydoc/traci/_calibrator.html#CalibratorDomain.getRouteProbeID) |
31+
| speed | double | Returns the target speed of the current calibration interval | [getSpeed](https://sumo.dlr.de/pydoc/traci/_calibrator.html#CalibratorDomain.getSpeed) |
32+
| type ID | string | Returns the type id for the current calibration interval | [getTypeID](https://sumo.dlr.de/pydoc/traci/_calibrator.html#CalibratorDomain.getTypeID) |
33+
| vTypes | string | Returns a list of all types to which the calibrator applies (in a type filter is active) | [getVTypes](https://sumo.dlr.de/pydoc/traci/_calibrator.html#CalibratorDomain.getVTypes) |
34+
| vehicle per hour | double | Returns the number of vehicles per hour in the current calibration interval | [getVehsPerHour](https://sumo.dlr.de/pydoc/traci/_calibrator.html#CalibratorDomain.getVehsPerHour) |

‎docs/web/docs/TraCI/Change_Calibrator_State.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ changed, the parameter which must be given are also shown in the table.
1919

2020
| Variable | ValueType | Description | [Python Method](../TraCI/Interfacing_TraCI_from_Python.md) |
2121
|---------------------------|----------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|
22-
| flow (0x18) | compound (string, double, double, double, double, string, string, string, string), see below | Set the hourly flow and speed at the calibrator location in a given time range. Missing traffic will be added with the given routeID (or routeDistribution ID) and type. DepartLane and departSpeed default to "first" and "max" but can optionally be set. For details on calibrating only flow, speed or type individually, see [Calibrator](../Simulation/Calibrator.md). | [setFlow](https://sumo.dlr.de/pydoc/traci._calibrator.html#CalibratorDomain-setFlow) |
22+
| flow (0x18) | compound (string, double, double, double, double, string, string, string, string), see below | Set the hourly flow and speed at the calibrator location in a given time range. Missing traffic will be added with the given routeID (or routeDistribution ID) and type. DepartLane and departSpeed default to "first" and "max" but can optionally be set. For details on calibrating only flow, speed or type individually, see [Calibrator](../Simulation/Calibrator.md). | [setFlow](https://sumo.dlr.de/pydoc/traci/_calibrator.html#CalibratorDomain.setFlow) |
2323

2424
# compound message details
2525

‎docs/web/docs/TraCI/Change_ChargingStation_State.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ given is also shown in the table.
1717

1818
| Variable | ValueType | Description | [Python Method](../TraCI/Interfacing_TraCI_from_Python.md) |
1919
| ------------------------ | ----------| ----------------- | -------------------------------------------------------------- |
20-
| power (0x97) | double | The charging power in W | [setChargingPower](https://sumo.dlr.de/pydoc/traci._chargingstation.html#ChargingStationDomain-setChargingPower) |
21-
| efficiency (0x98) | double | The charging efficiency | [setEfficiency](https://sumo.dlr.de/pydoc/traci._chargingstation.html#ChargingStationDomain-setEfficiency) |
22-
| charge in transit (0x99) | integer | Whether the vehicle is forced/not forced to stop for charging | [setChargeInTransit](https://sumo.dlr.de/pydoc/traci._chargingstation.html#ChargingStationDomain-setChargeInTransit) |
23-
| charge delay (0x9a) | double | The time delay before starting charging in s | [setChargeDelay](https://sumo.dlr.de/pydoc/traci._chargingstation.html#ChargingStationDomain-setChargeDelay) |
24-
20+
| power (0x97) | double | The charging power in W | [setChargingPower](https://sumo.dlr.de/pydoc/traci/_chargingstation.html#ChargingStationDomain.setChargingPower) |
21+
| efficiency (0x98) | double | The charging efficiency | [setEfficiency](https://sumo.dlr.de/pydoc/traci/_chargingstation.html#ChargingStationDomain.setEfficiency) |
22+
| charge in transit (0x99) | integer | Whether the vehicle is forced/not forced to stop for charging | [setChargeInTransit](https://sumo.dlr.de/pydoc/traci/_chargingstation.html#ChargingStationDomain.setChargeInTransit) |
23+
| charge delay (0x9a) | double | The time delay before starting charging in s | [setChargeDelay](https://sumo.dlr.de/pydoc/traci/_chargingstation.html#ChargingStationDomain.setChargeDelay) |

‎docs/web/docs/TraCI/Change_Edge_State.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ parameter which must be given are also shown in the table.
1818

1919
| Variable | ValueType | Description | [Python Method](../TraCI/Interfacing_TraCI_from_Python.md) |
2020
| -------------------------------------------- | ------------------------------------------------- | -------------------------- | ------------------------------------ |
21-
| change global travel time information (0x58) | compound (begin time, end time, value), see below | Inserts the information about the travel time of the named edge valid from begin time to end time into the global edge weights times container. | [adaptTraveltime](https://sumo.dlr.de/pydoc/traci._edge.html#EdgeDomain-adaptTraveltime) |
22-
| change global effort information (0x59) | compound (begin time, end time, value), see below | Inserts the information about the effort of the named edge valid from begin time to end time into the global edge weights container. | [setEffort](https://sumo.dlr.de/pydoc/traci._edge.html#EdgeDomain-setEffort) |
23-
| change max speed (0x41) | | Set a new maximum speed (in m/s) for all lanes of the edge. | [setMaxSpeed](https://sumo.dlr.de/pydoc/traci._edge.html#EdgeDomain-setMaxSpeed) |
21+
| change global travel time information (0x58) | compound (begin time, end time, value), see below | Inserts the information about the travel time of the named edge valid from begin time to end time into the global edge weights times container. | [adaptTraveltime](https://sumo.dlr.de/pydoc/traci/_edge.html#EdgeDomain.adaptTraveltime) |
22+
| change global effort information (0x59) | compound (begin time, end time, value), see below | Inserts the information about the effort of the named edge valid from begin time to end time into the global edge weights container. | [setEffort](https://sumo.dlr.de/pydoc/traci/_edge.html#EdgeDomain.setEffort) |
23+
| change max speed (0x41) | | Set a new maximum speed (in m/s) for all lanes of the edge. | [setMaxSpeed](https://sumo.dlr.de/pydoc/traci/_edge.html#EdgeDomain.setMaxSpeed) |
2424

2525

2626
The message contents are as following:

0 commit comments

Comments
 (0)