Skip to content

Commit

Permalink
Removed TIM reference from configuration documentation & fixed some t…
Browse files Browse the repository at this point in the history
…ypos
  • Loading branch information
dmccoystephenson committed Sep 22, 2024
1 parent 3836cbd commit ee9bcd8
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,22 +129,21 @@ if the message is published. The `metadata:sanitized` element is changed to `tru
all messages published by the PPM should have a `metadata:sanitized` value of `true`.
The `payload` component of the BSM has a `data` object containing the `coreData` object that is analyzed by the PPM
for features that may cause it to be suppressed. The same analysis is done on the `receivedDetails:loction` object in the TIMS
`metadata` component. Note that the `payload` for TIMS is not inspected.
for features that may cause it to be suppressed.
The JSON format published by the PPM follows the format received. It may be completely suppressed or certain fields may
be modifed as described in this second and the sections that follow.
be modified as described in this second and the sections that follow.
### Velocity Filtering
- `privacy.filter.velocity` : enables or disables message filtering based on the speed within the message.
- `ON` : enables message filtering.
- Any other value : disables message filtering.
- `privacy.filter.velocity.min` : *When velocity fitering is enabled*, messages having velocities below this value will be
- `privacy.filter.velocity.min` : *When velocity filtering is enabled*, messages having velocities below this value will be
suppressed. The units are in meters per second.
- `privacy.filter.velocity.max` : *When velocity fitering is enabled*, messages having velocities above this value will be
- `privacy.filter.velocity.max` : *When velocity filtering is enabled*, messages having velocities above this value will be
suppressed. The units are in meters per second.
### BSM Identifier Redaction
Expand Down Expand Up @@ -182,9 +181,9 @@ control vehicle size redaction.
Messages can be suppressed based on latitude and longitude attributes. If this
capability is turned on through the configuration file, each edge defined in the
map file is used to infer a *component* geofence that surrounds that segment of the
road. The image below illustrates how a *rectange* is drawn to form the segment's
road. The image below illustrates how a *rectangle* is drawn to form the segment's
geofence. The aforementioned edge attributes and PPM configuration parameters
determine the size of the rectange.
determine the size of the rectangle.
![Road Segment Geofence Dimensions](graphics/geofence-dimensions.png)
Expand Down

0 comments on commit ee9bcd8

Please sign in to comment.