diff --git a/docs/reference/accelerometer.md b/docs/reference/accelerometer.md index 0f2ce2ba5d9..6bfa8fa59e4 100644 --- a/docs/reference/accelerometer.md +++ b/docs/reference/accelerometer.md @@ -2,16 +2,6 @@ Derived from [Device](device.md) and [Solid](solid.md). -``` -Accelerometer { - MFVec3f lookupTable [ ] # lookup table - SFBool xAxis TRUE # {TRUE, FALSE} - SFBool yAxis TRUE # {TRUE, FALSE} - SFBool zAxis TRUE # {TRUE, FALSE} - SFFloat resolution -1 # [0, inf) -} -``` - ### Description The [Accelerometer](#accelerometer) node can be used to model accelerometer devices such as those commonly found in mobile electronics, robots and game input devices. @@ -21,6 +11,20 @@ The parent node of an [Accelerometer](#accelerometer) node should have a [Physic ### Field Summary +``` +Accelerometer { + SFString name "accelerometer" # used by wb_robot_get_device() + MFVec3f lookupTable [ ] # lookup table + SFBool xAxis TRUE # {TRUE, FALSE} + SFBool yAxis TRUE # {TRUE, FALSE} + SFBool zAxis TRUE # {TRUE, FALSE} + SFFloat resolution -1 # [0, inf) +} +``` +**Note**: The above description lists only the fields specific to the Accelerometer node. The complete field list can be found in the [Accelerometer.wrl]({{ url.github_tree }}/resources/nodes/Accelerometer.wrl) definition file. + +- `name`: This field defines the string name used by `wb_robot_get_device()` to get the `WbDeviceTag` handle of this sensor. Its default value is "accelerometer". + - `lookupTable`: This field optionally specifies a lookup table that can be used for mapping the raw acceleration values [m/s²] to device specific output values. By default the lookup table is empty and therefore the raw acceleration values are returned (no mapping). See the section on the [DistanceSensor](distancesensor.md#lookup-table) node for more explanation on how a `lookupTable` works.