Skip to content

Commit c46af52

Browse files
authored
Fix spelling errors (mavlink#1866)
Fixed with: codespell --summary --ignore-words-list mot,ned,parm,parms,upto --skip cmake --write-changes Co-authored-by: Daniele Forsi <[email protected]>
1 parent 8d100f9 commit c46af52

File tree

10 files changed

+35
-35
lines changed

10 files changed

+35
-35
lines changed

component_metadata/actuators.schema.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,17 @@
1717
"properties": {
1818
"min": {
1919
"type": "number",
20-
"minium": -1,
20+
"minimum": -1,
2121
"maximum": 1
2222
},
2323
"max": {
2424
"type": "number",
25-
"minium": -1,
25+
"minimum": -1,
2626
"maximum": 1
2727
},
2828
"default": {
2929
"type": "number",
30-
"minium": -1,
30+
"minimum": -1,
3131
"maximum": 1
3232
},
3333
"default-is-nan": {

component_metadata/parameter.schema.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
"enum": [ "Uint8", "Int8", "Uint16", "Int16", "Uint32", "Int32", "Float" ]
2929
},
3030
"shortDesc": {
31-
"description": "Short user facing description/name for parameter. Used in UI intead of internal parameter name.",
31+
"description": "Short user facing description/name for parameter. Used in UI instead of internal parameter name.",
3232
"type": "string",
3333
"default": "",
3434
"comment": "{n} index tagging will be replaced by name index. Example: 'FOO3_BAR': 'Description for foo element {n}' will turn into 'Description for foo element 1'."
@@ -43,7 +43,7 @@
4343
"description": "Units for parameter value.",
4444
"type": "string",
4545
"default": "",
46-
"comment": "A 'Known Unit' allows a GCS to convert between units like meters to feet as needed. Known Units are: 'm/meter/meter', 'vertical m' - vertical distance, 'cm/px', 'm/s', 'C' - celcius, 'm^2', 'g' - grams, 'centi-degrees', 'radians', 'norm'."
46+
"comment": "A 'Known Unit' allows a GCS to convert between units like meters to feet as needed. Known Units are: 'm/meter/meter', 'vertical m' - vertical distance, 'cm/px', 'm/s', 'C' - celsius, 'm^2', 'g' - grams, 'centi-degrees', 'radians', 'norm'."
4747
},
4848
"default": {
4949
"description": "Default value for parameter.",

doc/mavlink.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
<br />
5858

5959
<p>
60-
Messages are defined by the <a href="https://raw.github.com/mavlink/mavlink/master/message_definitions/v1.0/common.xml">common.xml</a> file. The C packing/unpacking code is generated from this specification, as well as the HTML documentaiton in the section above.<br />
60+
Messages are defined by the <a href="https://raw.github.com/mavlink/mavlink/master/message_definitions/v1.0/common.xml">common.xml</a> file. The C packing/unpacking code is generated from this specification, as well as the HTML documentation in the section above.<br />
6161
<br />
6262
<i>The XML displayed here is updated on every commit and therefore up-to-date.</i>
6363
</p>

doc/mavlink_gitbook.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
# XML Definition Files & Dialects
4242
4343
MAVLink definitions files can be found in [mavlink/message definitions](https://github.com/mavlink/mavlink/blob/master/message_definitions/).
44-
These can roughtly be divided into:
44+
These can roughly be divided into:
4545
- [Standard definitions](#standard-definitions) - core definitions shared by many flight stacks
4646
- [Test definitions](#test-definitions) - definitions to support testing and validation
4747
- [Dialects](#dialects) - *protocol-* and *vendor-specific* messages, enums and commands
@@ -54,7 +54,7 @@
5454
- [minimal.xml](minimal.md) - the minimum set of entities (messages, enums, MAV_CMD) required to set up a MAVLink network.
5555
- [standard.xml](standard.md) - the standard set of entities that are implemented by almost all flight stacks (at least 2, in a compatible way).
5656
This `includes` [minimal.xml](minimal.md).
57-
- [common.xml](../messages/common.md) - the set of entitites that have been implemented in at least one core flight stack.
57+
- [common.xml](../messages/common.md) - the set of entities that have been implemented in at least one core flight stack.
5858
This `includes` [standard.xml](minimal.md)
5959
6060
> **Note** We are still working towards moving the truly standard entities from **common.xml** to **standard.xml**

examples/linux/mavlink_udp.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
qgroundcontrol are printed by this program along with the heartbeats.
2222
2323
24-
I compiled this program sucessfully on Ubuntu 10.04 with the following command
24+
I compiled this program successfully on Ubuntu 10.04 with the following command
2525
2626
gcc -I ../../pixhawk/mavlink/include -o udp-server udp-server-test.c
2727

message_definitions/v1.0/common.xml

+14-14
Original file line numberDiff line numberDiff line change
@@ -225,10 +225,10 @@
225225
</entry>
226226
</enum>
227227
<enum name="MAV_FRAME">
228-
<description>Co-ordinate frames used by MAVLink. Not all frames are supported by all commands, messages, or vehicles.
228+
<description>Coordinate frames used by MAVLink. Not all frames are supported by all commands, messages, or vehicles.
229229

230230
Global frames use the following naming conventions:
231-
- "GLOBAL": Global co-ordinate frame with WGS84 latitude/longitude and altitude positive over mean sea level (MSL) by default.
231+
- "GLOBAL": Global coordinate frame with WGS84 latitude/longitude and altitude positive over mean sea level (MSL) by default.
232232
The following modifiers may be used with "GLOBAL":
233233
- "RELATIVE_ALT": Altitude is relative to the vehicle home position rather than MSL.
234234
- "TERRAIN_ALT": Altitude is relative to ground level rather than MSL.
@@ -273,7 +273,7 @@
273273
</entry>
274274
<entry value="8" name="MAV_FRAME_BODY_NED">
275275
<deprecated since="2019-08" replaced_by="MAV_FRAME_BODY_FRD"/>
276-
<description>Same as MAV_FRAME_LOCAL_NED when used to represent position values. Same as MAV_FRAME_BODY_FRD when used with velocity/accelaration values.</description>
276+
<description>Same as MAV_FRAME_LOCAL_NED when used to represent position values. Same as MAV_FRAME_BODY_FRD when used with velocity/acceleration values.</description>
277277
</entry>
278278
<entry value="9" name="MAV_FRAME_BODY_OFFSET_NED">
279279
<deprecated since="2019-08" replaced_by="MAV_FRAME_BODY_FRD"/>
@@ -3722,7 +3722,7 @@
37223722
<description>Zoom value as proportion of full camera range (a value between 0.0 and 100.0)</description>
37233723
</entry>
37243724
<entry value="3" name="ZOOM_TYPE_FOCAL_LENGTH">
3725-
<description>Zoom value/variable focal length in milimetres. Note that there is no message to get the valid zoom range of the camera, so this can type can only be used for cameras where the zoom range is known (implying that this cannot reliably be used in a GCS for an arbitrary camera)</description>
3725+
<description>Zoom value/variable focal length in millimetres. Note that there is no message to get the valid zoom range of the camera, so this can type can only be used for cameras where the zoom range is known (implying that this cannot reliably be used in a GCS for an arbitrary camera)</description>
37263726
</entry>
37273727
</enum>
37283728
<enum name="SET_FOCUS_TYPE">
@@ -3761,7 +3761,7 @@
37613761
<description>Parameter failed to set</description>
37623762
</entry>
37633763
<entry value="3" name="PARAM_ACK_IN_PROGRESS">
3764-
<description>Parameter value received but not yet set/accepted. A subsequent PARAM_ACK_TRANSACTION or PARAM_EXT_ACK with the final result will follow once operation is completed. This is returned immediately for parameters that take longer to set, indicating taht the the parameter was recieved and does not need to be resent.</description>
3764+
<description>Parameter value received but not yet set/accepted. A subsequent PARAM_ACK_TRANSACTION or PARAM_EXT_ACK with the final result will follow once operation is completed. This is returned immediately for parameters that take longer to set, indicating that the the parameter was received and does not need to be resent.</description>
37653765
</entry>
37663766
</enum>
37673767
<enum name="CAMERA_MODE">
@@ -3965,7 +3965,7 @@
39653965
<description>SIM is required for the modem but missing</description>
39663966
</entry>
39673967
<entry value="3" name="CELLULAR_NETWORK_FAILED_REASON_SIM_ERROR">
3968-
<description>SIM is available, but not usuable for connection</description>
3968+
<description>SIM is available, but not usable for connection</description>
39693969
</entry>
39703970
</enum>
39713971
<enum name="CELLULAR_NETWORK_RADIO_TYPE">
@@ -4595,7 +4595,7 @@
45954595
</description>
45964596
</entry>
45974597
<entry value="2" name="NAV_VTOL_LAND_OPTIONS_HOVER_DESCENT">
4598-
<description>Land in multicopter mode on reaching the landing co-ordinates (the whole landing is by "hover descent").</description>
4598+
<description>Land in multicopter mode on reaching the landing coordinates (the whole landing is by "hover descent").</description>
45994599
</entry>
46004600
</enum>
46014601
<enum name="MAV_WINCH_STATUS_FLAG" bitmask="true">
@@ -4631,7 +4631,7 @@
46314631
<description>Winch is redelivering the payload. This is a failover state if the line tension goes above a threshold during RETRACTING.</description>
46324632
</entry>
46334633
<entry value="1024" name="MAV_WINCH_STATUS_ABANDON_LINE">
4634-
<description>Winch is abandoning the line and possibly payload. Winch unspools the entire calculated line length. This is a failover state from REDELIVER if the number of attemps exceeds a threshold.</description>
4634+
<description>Winch is abandoning the line and possibly payload. Winch unspools the entire calculated line length. This is a failover state from REDELIVER if the number of attempts exceeds a threshold.</description>
46354635
</entry>
46364636
</enum>
46374637
<enum name="MAG_CAL_STATUS">
@@ -5225,7 +5225,7 @@
52255225
<field type="uint8_t" name="mission_type" enum="MAV_MISSION_TYPE">Mission type.</field>
52265226
</message>
52275227
<message id="48" name="SET_GPS_GLOBAL_ORIGIN">
5228-
<description>Sets the GPS co-ordinates of the vehicle local origin (0,0,0) position. Vehicle should emit GPS_GLOBAL_ORIGIN irrespective of whether the origin is changed. This enables transform between the local coordinate frame and the global (GPS) coordinate frame, which may be necessary when (for example) indoor and outdoor settings are connected and the MAV should move from in- to outdoor.</description>
5228+
<description>Sets the GPS coordinates of the vehicle local origin (0,0,0) position. Vehicle should emit GPS_GLOBAL_ORIGIN irrespective of whether the origin is changed. This enables transform between the local coordinate frame and the global (GPS) coordinate frame, which may be necessary when (for example) indoor and outdoor settings are connected and the MAV should move from in- to outdoor.</description>
52295229
<field type="uint8_t" name="target_system">System ID</field>
52305230
<field type="int32_t" name="latitude" units="degE7">Latitude (WGS84)</field>
52315231
<field type="int32_t" name="longitude" units="degE7">Longitude (WGS84)</field>
@@ -5234,7 +5234,7 @@
52345234
<field type="uint64_t" name="time_usec" units="us">Timestamp (UNIX Epoch time or time since system boot). The receiving end can infer timestamp format (since 1.1.1970 or since system boot) by checking for the magnitude of the number.</field>
52355235
</message>
52365236
<message id="49" name="GPS_GLOBAL_ORIGIN">
5237-
<description>Publishes the GPS co-ordinates of the vehicle local origin (0,0,0) position. Emitted whenever a new GPS-Local position mapping is requested or set - e.g. following SET_GPS_GLOBAL_ORIGIN message.</description>
5237+
<description>Publishes the GPS coordinates of the vehicle local origin (0,0,0) position. Emitted whenever a new GPS-Local position mapping is requested or set - e.g. following SET_GPS_GLOBAL_ORIGIN message.</description>
52385238
<field type="int32_t" name="latitude" units="degE7">Latitude (WGS84)</field>
52395239
<field type="int32_t" name="longitude" units="degE7">Longitude (WGS84)</field>
52405240
<field type="int32_t" name="altitude" units="mm">Altitude (MSL). Positive for up.</field>
@@ -5804,7 +5804,7 @@
58045804
</message>
58055805
<message id="109" name="RADIO_STATUS">
58065806
<description>Status generated by radio and injected into MAVLink stream.</description>
5807-
<field type="uint8_t" name="rssi" invalid="UINT8_MAX">Local (message sender) recieved signal strength indication in device-dependent units/scale. Values: [0-254], UINT8_MAX: invalid/unknown.</field>
5807+
<field type="uint8_t" name="rssi" invalid="UINT8_MAX">Local (message sender) received signal strength indication in device-dependent units/scale. Values: [0-254], UINT8_MAX: invalid/unknown.</field>
58085808
<field type="uint8_t" name="remrssi" invalid="UINT8_MAX">Remote (message receiver) signal strength indication in device-dependent units/scale. Values: [0-254], UINT8_MAX: invalid/unknown.</field>
58095809
<field type="uint8_t" name="txbuf" units="%">Remaining free transmitter buffer space.</field>
58105810
<field type="uint8_t" name="noise" invalid="UINT8_MAX">Local background noise level. These are device dependent RSSI values (scale as approx 2x dB on SiK radios). Values: [0-254], UINT8_MAX: invalid/unknown.</field>
@@ -5831,7 +5831,7 @@
58315831
</message>
58325832
<message id="113" name="HIL_GPS">
58335833
<description>The global position, as returned by the Global Positioning System (GPS). This is
5834-
NOT the global position estimate of the sytem, but rather a RAW sensor value. See message GLOBAL_POSITION_INT for the global position estimate.</description>
5834+
NOT the global position estimate of the system, but rather a RAW sensor value. See message GLOBAL_POSITION_INT for the global position estimate.</description>
58355835
<field type="uint64_t" name="time_usec" units="us">Timestamp (UNIX Epoch time or time since system boot). The receiving end can infer timestamp format (since 1.1.1970 or since system boot) by checking for the magnitude of the number.</field>
58365836
<field type="uint8_t" name="fix_type">0-1: no fix, 2: 2D fix, 3: 3D fix. Some applications will not use the value of this field unless it is at least two, so always correctly fill in the fix.</field>
58375837
<field type="int32_t" name="lat" units="degE7">Latitude (WGS84)</field>
@@ -7336,7 +7336,7 @@
73367336
<field type="uint8_t[64]" name="data">Frame data</field>
73377337
</message>
73387338
<message id="388" name="CAN_FILTER_MODIFY">
7339-
<description>Modify the filter of what CAN messages to forward over the mavlink. This can be used to make CAN forwarding work well on low bandwith links. The filtering is applied on bits 8 to 24 of the CAN id (2nd and 3rd bytes) which corresponds to the DroneCAN message ID for DroneCAN. Filters with more than 16 IDs can be constructed by sending multiple CAN_FILTER_MODIFY messages.</description>
7339+
<description>Modify the filter of what CAN messages to forward over the mavlink. This can be used to make CAN forwarding work well on low bandwidth links. The filtering is applied on bits 8 to 24 of the CAN id (2nd and 3rd bytes) which corresponds to the DroneCAN message ID for DroneCAN. Filters with more than 16 IDs can be constructed by sending multiple CAN_FILTER_MODIFY messages.</description>
73407340
<field type="uint8_t" name="target_system">System ID.</field>
73417341
<field type="uint8_t" name="target_component">Component ID.</field>
73427342
<field type="uint8_t" name="bus">bus number</field>
@@ -7459,7 +7459,7 @@
74597459
<field type="uint8_t" name="target_system">System ID (0 for broadcast).</field>
74607460
<field type="uint8_t" name="target_component">Component ID (0 for broadcast).</field>
74617461
<field type="uint8_t[20]" name="id_or_mac">Only used for drone ID data received from other UAs. See detailed description at https://mavlink.io/en/services/opendroneid.html. </field>
7462-
<field type="uint8_t" name="single_message_size" units="bytes">This field must currently always be equal to 25 (bytes), since all encoded OpenDroneID messages are specificed to have this length.</field>
7462+
<field type="uint8_t" name="single_message_size" units="bytes">This field must currently always be equal to 25 (bytes), since all encoded OpenDroneID messages are specified to have this length.</field>
74637463
<field type="uint8_t" name="msg_pack_size">Number of encoded messages in the pack (not the number of bytes). Allowed range is 1 - 9.</field>
74647464
<field type="uint8_t[225]" name="messages">Concatenation of encoded OpenDroneID messages. Shall be filled with nulls in the unused portion of the field.</field>
74657465
</message>

message_definitions/v1.0/development.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@
258258
<field type="int16_t" name="start_index">Start index for partial mission change (-1 for all items).</field>
259259
<field type="int16_t" name="end_index">End index of a partial mission change. -1 is a synonym for the last mission item (i.e. selects all items from start_index). Ignore field if start_index=-1.</field>
260260
<field type="uint8_t" name="origin_sysid">System ID of the author of the new mission.</field>
261-
<field type="uint8_t" name="origin_compid" enum="MAV_COMPONENT">Compnent ID of the author of the new mission.</field>
261+
<field type="uint8_t" name="origin_compid" enum="MAV_COMPONENT">Component ID of the author of the new mission.</field>
262262
<field type="uint8_t" name="mission_type" enum="MAV_MISSION_TYPE">Mission type.</field>
263263
</message>
264264
<message id="53" name="MISSION_CHECKSUM">
@@ -314,7 +314,7 @@
314314
<field type="uint32_t" name="time_boot_ms" units="ms">Timestamp (time since system boot).</field>
315315
<field type="uint8_t[32]" name="vendor_name">Name of the component vendor</field>
316316
<field type="uint8_t[32]" name="model_name">Name of the component model</field>
317-
<field type="char[24]" name="software_version">Sofware version. The version format can be custom, recommended is SEMVER 'major.minor.patch'.</field>
317+
<field type="char[24]" name="software_version">Software version. The version format can be custom, recommended is SEMVER 'major.minor.patch'.</field>
318318
<field type="char[24]" name="hardware_version">Hardware version. The version format can be custom, recommended is SEMVER 'major.minor.patch'.</field>
319319
<field type="uint64_t" name="capabilities" enum="MAV_PROTOCOL_CAPABILITY" display="bitmask">Component capability flags</field>
320320
</message>

0 commit comments

Comments
 (0)