robot-models-lib 0.2.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (96) hide show
  1. robot_models/__init__.py +18 -0
  2. robot_models/actuators/__init__.py +1 -0
  3. robot_models/actuators/rungs/README.md +24 -0
  4. robot_models/actuators/rungs/coulomb_viscous/README.md +61 -0
  5. robot_models/actuators/rungs/coulomb_viscous/model.js +14 -0
  6. robot_models/actuators/rungs/coulomb_viscous/model.json +102 -0
  7. robot_models/actuators/rungs/coulomb_viscous/model.py +24 -0
  8. robot_models/actuators/rungs/datasheet/README.md +65 -0
  9. robot_models/actuators/rungs/datasheet/model.js +14 -0
  10. robot_models/actuators/rungs/datasheet/model.json +138 -0
  11. robot_models/actuators/rungs/datasheet/model.py +24 -0
  12. robot_models/actuators/rungs/dcmotor/README.md +63 -0
  13. robot_models/actuators/rungs/dcmotor/model.json +163 -0
  14. robot_models/actuators/rungs/ideal/README.md +60 -0
  15. robot_models/actuators/rungs/ideal/model.js +6 -0
  16. robot_models/actuators/rungs/ideal/model.json +90 -0
  17. robot_models/actuators/rungs/ideal/model.py +13 -0
  18. robot_models/actuators/rungs/load/README.md +65 -0
  19. robot_models/actuators/rungs/load/model.js +15 -0
  20. robot_models/actuators/rungs/load/model.json +117 -0
  21. robot_models/actuators/rungs/load/model.py +25 -0
  22. robot_models/actuators/rungs/lugre/README.md +72 -0
  23. robot_models/actuators/rungs/lugre/model.js +24 -0
  24. robot_models/actuators/rungs/lugre/model.json +164 -0
  25. robot_models/actuators/rungs/lugre/model.py +30 -0
  26. robot_models/actuators/rungs/ripple/README.md +64 -0
  27. robot_models/actuators/rungs/ripple/model.js +17 -0
  28. robot_models/actuators/rungs/ripple/model.json +119 -0
  29. robot_models/actuators/rungs/ripple/model.py +27 -0
  30. robot_models/actuators/rungs/stribeck/README.md +65 -0
  31. robot_models/actuators/rungs/stribeck/model.js +17 -0
  32. robot_models/actuators/rungs/stribeck/model.json +126 -0
  33. robot_models/actuators/rungs/stribeck/model.py +28 -0
  34. robot_models/actuators/servo/README.md +278 -0
  35. robot_models/actuators/servo/__init__.py +7 -0
  36. robot_models/actuators/servo/bldc/README.md +186 -0
  37. robot_models/actuators/servo/bldc/__init__.py +5 -0
  38. robot_models/actuators/servo/bldc/bldc_motor.py +93 -0
  39. robot_models/actuators/servo/bldc/ladder.py +268 -0
  40. robot_models/actuators/servo/foc_controller/README.md +127 -0
  41. robot_models/actuators/servo/foc_controller/__init__.py +3 -0
  42. robot_models/actuators/servo/foc_controller/ladder.py +207 -0
  43. robot_models/actuators/servo/gearbox/README.md +148 -0
  44. robot_models/actuators/servo/gearbox/__init__.py +5 -0
  45. robot_models/actuators/servo/gearbox/gearbox.py +36 -0
  46. robot_models/actuators/servo/gearbox/ladder.py +214 -0
  47. robot_models/actuators/servo/integrated_servo.py +33 -0
  48. robot_models/actuators/servo/ladder.py +593 -0
  49. robot_models/arms/__init__.py +1 -0
  50. robot_models/arms/rigid_body_chain/README.md +151 -0
  51. robot_models/arms/rigid_body_chain/__init__.py +3 -0
  52. robot_models/arms/rigid_body_chain/ladder.py +228 -0
  53. robot_models/conveyors/__init__.py +1 -0
  54. robot_models/conveyors/conveyor/README.md +140 -0
  55. robot_models/conveyors/conveyor/__init__.py +1 -0
  56. robot_models/conveyors/conveyor/ladder.py +203 -0
  57. robot_models/datasheet/__init__.py +56 -0
  58. robot_models/datasheet/datasheet.py +355 -0
  59. robot_models/datasheet/literal.py +144 -0
  60. robot_models/datasheet/source.py +328 -0
  61. robot_models/datasheet/stated.py +135 -0
  62. robot_models/datasheet/units.py +57 -0
  63. robot_models/end_effectors/__init__.py +1 -0
  64. robot_models/end_effectors/gripper/README.md +112 -0
  65. robot_models/end_effectors/gripper/__init__.py +3 -0
  66. robot_models/end_effectors/gripper/ladder.py +150 -0
  67. robot_models/homing/__init__.py +38 -0
  68. robot_models/homing/cad_bundle.py +206 -0
  69. robot_models/homing/contact.py +201 -0
  70. robot_models/homing/fit.py +126 -0
  71. robot_models/homing/metrics.py +237 -0
  72. robot_models/homing/protocols.py +72 -0
  73. robot_models/homing/types.py +256 -0
  74. robot_models/ladder.py +645 -0
  75. robot_models/markers/__init__.py +1 -0
  76. robot_models/markers/aruco_marker/README.md +92 -0
  77. robot_models/markers/aruco_marker/__init__.py +2 -0
  78. robot_models/markers/aruco_marker/ladder.py +142 -0
  79. robot_models/references.py +429 -0
  80. robot_models/sensors/__init__.py +1 -0
  81. robot_models/sensors/camera/README.md +118 -0
  82. robot_models/sensors/camera/__init__.py +3 -0
  83. robot_models/sensors/camera/ladder.py +108 -0
  84. robot_models/sensors/encoder/README.md +103 -0
  85. robot_models/sensors/encoder/__init__.py +5 -0
  86. robot_models/sensors/encoder/ladder.py +133 -0
  87. robot_models/sensors/hyperspectral_camera/README.md +107 -0
  88. robot_models/sensors/hyperspectral_camera/__init__.py +1 -0
  89. robot_models/sensors/hyperspectral_camera/ladder.py +151 -0
  90. robot_models/sensors/rgbd/README.md +113 -0
  91. robot_models/sensors/rgbd/__init__.py +5 -0
  92. robot_models/sensors/rgbd/ladder.py +113 -0
  93. robot_models_lib-0.2.0.dist-info/METADATA +143 -0
  94. robot_models_lib-0.2.0.dist-info/RECORD +96 -0
  95. robot_models_lib-0.2.0.dist-info/WHEEL +4 -0
  96. robot_models_lib-0.2.0.dist-info/licenses/LICENSE +21 -0
@@ -0,0 +1,92 @@
1
+ > **Generated file.** Written by [`tools/make_type_docs.py`](../../../../tools/make_type_docs.py) from this folder's [`ladder.py`](ladder.py): edit the ladder, not this file, then run `python tools/make_type_docs.py` from the repository root.
2
+
3
+ # aruco_marker
4
+
5
+ A printed sheet carrying one or more ArUco markers rigidly.
6
+
7
+ **4 rungs** · 8 parameters · 3 aliases · 0 packed names · 0 deployment-only names · folder `markers/aruco_marker/`.
8
+
9
+ In code: `ladders()["aruco_marker"]` from [`robot_models.ladder`](../../ladder.py). Every type: [docs/TYPES.md](../../../../docs/TYPES.md). Spec: [PEP 0004](../../../../docs/peps/0004-model-ladders-by-type.md).
10
+
11
+ ## About
12
+
13
+ From the docstring of [`ladder.py`](ladder.py):
14
+
15
+ The ladder places the sheet's marker corners in the world. M0 reads the sheet as CAD designed it, M1 adds how it was
16
+ actually stuck down, M2 how far the print is from its designed size, and M3 that the sheet is not flat.
17
+
18
+ Spec: PEP 0004 §5.13 and §6.12.
19
+
20
+ ## The ladder
21
+
22
+ ```mermaid
23
+ flowchart BT
24
+ M0_nominal["M0.nominal<br/>The sheet as designed,<br/>where CAD put it"]
25
+ M1_as_built["M1.as_built<br/>How the sheet was<br/>actually stuck down"]
26
+ M2_print_scale["M2.print_scale<br/>Print scale"]
27
+ M3_curl["M3.curl<br/>A sheet that is not flat"]
28
+ M0_nominal --> M1_as_built
29
+ M1_as_built --> M2_print_scale
30
+ M2_print_scale --> M3_curl
31
+ classDef physics fill:#e8f1fb,stroke:#2f6aa3,color:#10243a
32
+ class M0_nominal,M1_as_built,M2_print_scale,M3_curl physics
33
+ ```
34
+
35
+ Read it bottom up: each solid arrow runs from a rung's base to the rung that extends it, and a rung needs everything below it on its own chain (its fallback). Blue box: a physics rung.
36
+
37
+ ## Rungs
38
+
39
+ Bottom up. *Needs* is what the rung's model cannot run without, new over its base; *reads when stated* is what it uses when a source states it. A rung needs everything its base needs.
40
+
41
+ | rung | title | base | needs (adds) | reads when stated (optional) | code | equation | references |
42
+ | --- | --- | --- | --- | --- | --- | --- | --- |
43
+ | <a id="rung-m0-nominal"></a>`M0.nominal` | The sheet as designed, where CAD put it | — | `dictionary`, `marker_ids`, `marker_length`, `layout`, `pose_on_link` | — | — | `X_corner = FK(q) · pose_on_link · layout_corner` | [ZHANG_2000](#ref-zhang_2000), [GARRIDO_2014](#ref-garrido_2014) |
44
+ | <a id="rung-m1-as_built"></a>`M1.as_built` | How the sheet was actually stuck down | [`M0.nominal`](#rung-m0-nominal) | `as_built_offset` | — | — | `X_corner = FK(q) · pose_on_link · as_built_offset · layout_corner` | [TRIGGS_2000](#ref-triggs_2000) |
45
+ | <a id="rung-m2-print_scale"></a>`M2.print_scale` | Print scale | [`M1.as_built`](#rung-m1-as_built) | `print_scale` | — | — | `X_corner = FK(q) · pose_on_link · as_built_offset · (print_scale · layout_corner)` | [STROBL_2011](#ref-strobl_2011) |
46
+ | <a id="rung-m3-curl"></a>`M3.curl` | A sheet that is not flat | [`M2.print_scale`](#rung-m2-print_scale) | `flatness` | — | — | `layout_corner z = flatness·(2x/L)² (a bow across the sheet's length L)` | [STROBL_2011](#ref-strobl_2011) |
47
+
48
+ ## Vocabulary
49
+
50
+ Every parameter the ladder holds, by the rung that first reads it. — as a unit: dimensionless (a ratio or a count).
51
+
52
+ | parameter | SI unit | shape | definition | first read on |
53
+ | --- | --- | --- | --- | --- |
54
+ | <a id="param-dictionary"></a>`dictionary` | — | text | The ArUco dictionary the sheet is printed in. | [`M0.nominal`](#rung-m0-nominal) |
55
+ | <a id="param-marker_ids"></a>`marker_ids` | — | list | The marker ids the sheet carries. | [`M0.nominal`](#rung-m0-nominal) |
56
+ | <a id="param-marker_length"></a>`marker_length` | m | scalar | Side of each marker's black square. | [`M0.nominal`](#rung-m0-nominal) |
57
+ | <a id="param-layout"></a>`layout` | m | map | Each marker's corners in the sheet's own frame. | [`M0.nominal`](#rung-m0-nominal) |
58
+ | <a id="param-pose_on_link"></a>`pose_on_link` | m, rad | pose | The sheet's frame on the link it is stuck to. | [`M0.nominal`](#rung-m0-nominal) |
59
+ | <a id="param-as_built_offset"></a>`as_built_offset` | m, rad | pose | How the sheet was actually stuck down: its offset from pose_on_link. | [`M1.as_built`](#rung-m1-as_built) |
60
+ | <a id="param-print_scale"></a>`print_scale` | — | scalar | Printed size over designed size. | [`M2.print_scale`](#rung-m2-print_scale) |
61
+ | <a id="param-flatness"></a>`flatness` | m | scalar | The sheet's out-of-plane bow at its far end. | [`M3.curl`](#rung-m3-curl) |
62
+
63
+ ## Aliases
64
+
65
+ Other names a source uses for one of these parameters. A note says how it differs when it is not the same quantity one for one. The unit is the one the source writes its values in; *(canonical)* after it marks an alias stored with no unit of its own, which robot_models reads as the canonical parameter's SI unit, shown here spelled out. A note can still qualify that unit.
66
+
67
+ | alias | canonical | unit | note |
68
+ | --- | --- | --- | --- |
69
+ | `flatness_m` | [`flatness`](#param-flatness) | m *(canonical)* | |
70
+ | `layout_m` | [`layout`](#param-layout) | m *(canonical)* | |
71
+ | `marker_length_m` | [`marker_length`](#param-marker_length) | m *(canonical)* | |
72
+
73
+ ## Packed names
74
+
75
+ Names for one array that carries several of these parameters; never read as one parameter.
76
+
77
+ None.
78
+
79
+ ## Deployment-only names
80
+
81
+ Names some model reads that are not the type's own: a deployment sets them, or the mount gives them.
82
+
83
+ None.
84
+
85
+ ## References
86
+
87
+ The works the rungs cite, by their names in [`robot_models.references`](../../references.py).
88
+
89
+ - <a id="ref-garrido_2014"></a>**GARRIDO_2014**: Garrido-Jurado, Muñoz-Salinas, Madrid-Cuevas, Marín-Jiménez (2014). Automatic generation and detection of highly reliable fiducial markers under occlusion. Pattern Recognition 47(6):2280-2292. no stable URL or DOI. What the rung uses: the ArUco dictionaries, their ids and the detector OpenCV ships. Cited by [`M0.nominal`](#rung-m0-nominal).
90
+ - <a id="ref-strobl_2011"></a>**STROBL_2011**: Strobl, Hirzinger (2011). More accurate pinhole camera calibration with imperfect planar target. IEEE International Conference on Computer Vision Workshops. no stable URL or DOI. What the rung uses: a target's own geometry (scale, flatness) fitted with the camera. Cited by [`M2.print_scale`](#rung-m2-print_scale), [`M3.curl`](#rung-m3-curl).
91
+ - <a id="ref-triggs_2000"></a>**TRIGGS_2000**: Triggs, McLauchlan, Hartley, Fitzgibbon (2000). Bundle adjustment: a modern synthesis. Vision Algorithms: Theory and Practice, LNCS 1883, Springer. no stable URL or DOI (chapter). What the rung uses: robust bundle adjustment, priors and the gauge (one sticker held at CAD). Cited by [`M1.as_built`](#rung-m1-as_built).
92
+ - <a id="ref-zhang_2000"></a>**ZHANG_2000**: Zhang (2000). A flexible new technique for camera calibration. IEEE Transactions on Pattern Analysis and Machine Intelligence. [doi:10.1109/34.888718](https://doi.org/10.1109/34.888718). What the rung uses: pinhole intrinsics from a planar target in several poses. Cited by [`M0.nominal`](#rung-m0-nominal).
@@ -0,0 +1,2 @@
1
+ """An ArUco marker sheet: a printed sheet that carries one or more ArUco markers rigidly on a link, with the ladder of
2
+ models that place its corners in the world, from the sheet as designed to the sheet as stuck down, scaled and bowed."""
@@ -0,0 +1,142 @@
1
+ """A printed sheet carrying one or more ArUco markers rigidly: its ladder of models (PEP 0004).
2
+
3
+ The ladder places the sheet's marker corners in the world. M0 reads the sheet as CAD designed it, M1 adds how it was
4
+ actually stuck down, M2 how far the print is from its designed size, and M3 that the sheet is not flat.
5
+
6
+ Spec: PEP 0004 §5.13 and §6.12.
7
+ """
8
+
9
+ from __future__ import annotations
10
+
11
+ from robot_models import references
12
+ from robot_models.ladder import Alias, Ladder, Parameter, Rung
13
+
14
+ # --- the vocabulary, grouped by the rung that first reads it ----------------------------------------------------------
15
+
16
+ # M0.nominal: the sheet as designed
17
+ DICTIONARY = Parameter(
18
+ name="dictionary",
19
+ unit="",
20
+ definition="The ArUco dictionary the sheet is printed in.",
21
+ shape="text",
22
+ )
23
+ MARKER_IDS = Parameter(
24
+ name="marker_ids",
25
+ unit="",
26
+ definition="The marker ids the sheet carries.",
27
+ shape="list",
28
+ )
29
+ MARKER_LENGTH = Parameter(
30
+ name="marker_length",
31
+ unit="m",
32
+ definition="Side of each marker's black square.",
33
+ )
34
+ LAYOUT = Parameter(
35
+ name="layout",
36
+ unit="m",
37
+ definition="Each marker's corners in the sheet's own frame.",
38
+ shape="map",
39
+ )
40
+ POSE_ON_LINK = Parameter(
41
+ name="pose_on_link",
42
+ unit="m, rad",
43
+ definition="The sheet's frame on the link it is stuck to.",
44
+ shape="pose",
45
+ )
46
+
47
+ # M1.as_built: how it was stuck down
48
+ AS_BUILT_OFFSET = Parameter(
49
+ name="as_built_offset",
50
+ unit="m, rad",
51
+ definition="How the sheet was actually stuck down: its offset from pose_on_link.",
52
+ shape="pose",
53
+ )
54
+
55
+ # M2.print_scale: the print against the design
56
+ PRINT_SCALE = Parameter(
57
+ name="print_scale",
58
+ unit="",
59
+ definition="Printed size over designed size.",
60
+ )
61
+
62
+ # M3.curl: a sheet that is not flat
63
+ FLATNESS = Parameter(
64
+ name="flatness",
65
+ unit="m",
66
+ definition="The sheet's out-of-plane bow at its far end.",
67
+ )
68
+
69
+ VOCABULARY = (
70
+ DICTIONARY,
71
+ MARKER_IDS,
72
+ MARKER_LENGTH,
73
+ LAYOUT,
74
+ POSE_ON_LINK,
75
+ AS_BUILT_OFFSET,
76
+ PRINT_SCALE,
77
+ FLATNESS,
78
+ )
79
+
80
+ # --- the rungs, M0 upward ---------------------------------------------------------------------------------------------
81
+
82
+ # WHY each rung adds one thing over the last (PEP 0004 §5.13): the fallback chain is the order a sheet is trusted less
83
+ # and fitted more, so a sheet with no measured offset still reaches M0 and places its corners where CAD put them.
84
+ RUNGS = (
85
+ Rung(
86
+ level=0,
87
+ name="nominal",
88
+ title="The sheet as designed, where CAD put it",
89
+ base=None,
90
+ adds=("dictionary", "marker_ids", "marker_length", "layout", "pose_on_link"),
91
+ equation="X_corner = FK(q) · pose_on_link · layout_corner",
92
+ references=(references.ZHANG_2000, references.GARRIDO_2014),
93
+ ),
94
+ Rung(
95
+ level=1,
96
+ name="as_built",
97
+ title="How the sheet was actually stuck down",
98
+ base="M0.nominal",
99
+ adds=("as_built_offset",),
100
+ equation="X_corner = FK(q) · pose_on_link · as_built_offset · layout_corner",
101
+ references=(references.TRIGGS_2000,),
102
+ ),
103
+ Rung(
104
+ level=2,
105
+ name="print_scale",
106
+ title="Print scale",
107
+ base="M1.as_built",
108
+ adds=("print_scale",),
109
+ equation="X_corner = FK(q) · pose_on_link · as_built_offset · (print_scale · layout_corner)",
110
+ references=(references.STROBL_2011,),
111
+ ),
112
+ Rung(
113
+ level=3,
114
+ name="curl",
115
+ title="A sheet that is not flat",
116
+ base="M2.print_scale",
117
+ adds=("flatness",),
118
+ equation="layout_corner z = flatness·(2x/L)² (a bow across the sheet's length L)",
119
+ references=(references.STROBL_2011,),
120
+ ),
121
+ )
122
+
123
+ # --- the other names --------------------------------------------------------------------------------------------------
124
+
125
+ # WHY plain aliases with no note or unit (PEP 0004 §6.12): each is the canonical quantity one for one, only spelled with
126
+ # the SI unit its sim2real card wrote in the name.
127
+ ALIASES = (
128
+ Alias(name="marker_length_m", canonical="marker_length"),
129
+ Alias(name="layout_m", canonical="layout"),
130
+ Alias(name="flatness_m", canonical="flatness"),
131
+ )
132
+
133
+ # WHY no packed or deployment-only names (PEP 0004 §5.13, §7): the sheet's quantities are all its own and none packs
134
+ # several into one array.
135
+
136
+ LADDER = Ladder(
137
+ type="aruco_marker",
138
+ title="A printed sheet carrying one or more ArUco markers rigidly.",
139
+ vocabulary=VOCABULARY,
140
+ rungs=RUNGS,
141
+ aliases=ALIASES,
142
+ )
@@ -0,0 +1,429 @@
1
+ """Where to learn each rung's model (PEP 0004): real, citable works for the type ladders to cite.
2
+
3
+ Copied on 2026-11-16 from the references sim2real's type cards cite, where every DOI was resolved at
4
+ Crossref with its title matched and every URL fetched. Works with no stable URL or DOI there (Brown 1966,
5
+ the ArUco paper, Triggs 2000, Strobl 2011) are cited without one. Left out, by PEP 0004 decision 4 (type
6
+ data only): a maker's manual or page, and one rig's own code. A ladder cites them as
7
+ `references=(ARMSTRONG_1994, OLSSON_1998)`. Nothing here is a value.
8
+ """
9
+
10
+ from __future__ import annotations
11
+
12
+ from .ladder import Reference
13
+
14
+
15
+ def _doi(title: str, doi: str, note: str = "", kind: str = "paper") -> Reference:
16
+ return Reference(title, url=f"https://doi.org/{doi}", kind=kind, doi=doi, note=note)
17
+
18
+
19
+ # --- friction, backlash, ripple, gears ----------------------------------------------------------------------
20
+ ARMSTRONG_1994 = _doi(
21
+ "Armstrong-Hélouvry, Dupont, Canudas de Wit (1994). A survey of models, analysis tools and "
22
+ "compensation methods for the control of machines with friction. Automatica.",
23
+ "10.1016/0005-1098(94)90209-7",
24
+ "Coulomb, viscous and Stribeck friction",
25
+ )
26
+ OLSSON_1998 = _doi(
27
+ "Olsson, Åström, Canudas de Wit, Gäfvert, Lischinsky (1998). Friction models and friction "
28
+ "compensation. European Journal of Control.",
29
+ "10.1016/S0947-3580(98)70113-X",
30
+ "static friction models from Coulomb + viscous to Stribeck",
31
+ )
32
+ CANUDAS_1995 = _doi(
33
+ "Canudas de Wit, Olsson, Åström, Lischinsky (1995). A new model for control of systems with "
34
+ "friction. IEEE Transactions on Automatic Control.",
35
+ "10.1109/9.376053",
36
+ "LuGre: the dynamic friction model robotparts' M3.lugre is",
37
+ )
38
+ KIRCANSKI_1997 = _doi(
39
+ "Kircanski, Goldenberg (1997). An experimental study of nonlinear stiffness, hysteresis, and "
40
+ "friction effects in robot joints with harmonic drives and torque sensors. The International "
41
+ "Journal of Robotics Research.",
42
+ "10.1177/027836499701600207",
43
+ "load-dependent friction and torsional stiffness measured in a joint",
44
+ )
45
+ NORDIN_2002 = _doi(
46
+ "Nordin, Gutman (2002). Controlling mechanical systems with backlash—a survey. Automatica.",
47
+ "10.1016/S0005-1098(02)00047-X",
48
+ "dead-zone backlash between motor and load",
49
+ )
50
+ TUTTLE_1996 = _doi(
51
+ "Tuttle, Seering (1996). A nonlinear model of a harmonic drive gear transmission. IEEE "
52
+ "Transactions on Robotics and Automation.",
53
+ "10.1109/70.499819",
54
+ "a gear's compliance, friction and kinematic error",
55
+ )
56
+ JAHNS_1996 = _doi(
57
+ "Jahns, Soong (1996). Pulsating torque minimization techniques for permanent magnet AC motor "
58
+ "drives—a review. IEEE Transactions on Industrial Electronics.",
59
+ "10.1109/41.491356",
60
+ "cogging and commutation ripple as rotor harmonics",
61
+ )
62
+
63
+ # --- motors and drives --------------------------------------------------------------------------------------
64
+ KRAUSE_2013 = _doi(
65
+ "Krause, Wasynczuk, Sudhoff, Pekarek (2013). Analysis of Electric Machinery and Drive Systems,"
66
+ " 3rd ed. Wiley-IEEE Press.",
67
+ "10.1002/9781118524336",
68
+ "the PM machine's electrical model: R, L, back-EMF, the voltage ceiling",
69
+ kind="book",
70
+ )
71
+ KRISHNAN_2010 = _doi(
72
+ "Krishnan (2010). Permanent Magnet Synchronous and Brushless DC Motor Drives. CRC Press.",
73
+ "10.1201/9781420014235",
74
+ "field-oriented current loops of PM drives",
75
+ kind="book",
76
+ )
77
+
78
+ # --- rigid bodies, chains and their calibration -------------------------------------------------------------
79
+ SICILIANO_2009 = _doi(
80
+ "Siciliano, Sciavicco, Villani, Oriolo (2009). Robotics: Modelling, Planning and Control. "
81
+ "Springer.",
82
+ "10.1007/978-1-84628-642-1",
83
+ "rigid-body joint dynamics and reflected inertia",
84
+ kind="book",
85
+ )
86
+ DH_1955 = _doi(
87
+ "Denavit, Hartenberg (1955). A kinematic notation for lower-pair mechanisms based on matrices."
88
+ " Journal of Applied Mechanics.",
89
+ "10.1115/1.4011045",
90
+ "the DH parameters of a serial chain",
91
+ )
92
+ HAYATI_1983 = _doi(
93
+ "Hayati (1983). Robot arm geometric link parameter estimation. The 22nd IEEE Conference on "
94
+ "Decision and Control.",
95
+ "10.1109/CDC.1983.269783",
96
+ "modified DH for parallel axes, the form kinematic calibration fits",
97
+ )
98
+ OKAMURA_1996 = _doi(
99
+ "Okamura, Park (1996). Kinematic calibration using the product of exponentials formula. "
100
+ "Robotica.",
101
+ "10.1017/S0263574700019810",
102
+ "a singularity-free calibration parameterisation",
103
+ )
104
+ HOLLERBACH_WAMPLER_1996 = _doi(
105
+ "Hollerbach, Wampler (1996). The calibration index and taxonomy for robot kinematic "
106
+ "calibration methods. The International Journal of Robotics Research.",
107
+ "10.1177/027836499601500604",
108
+ "open- and closed-loop kinematic calibration",
109
+ )
110
+ HOLLERBACH_2016 = _doi(
111
+ "Hollerbach, Khalil, Gautier (2016). Model identification. In Springer Handbook of Robotics, "
112
+ "2nd ed. Springer.",
113
+ "10.1007/978-3-319-32552-1_6",
114
+ "kinematic calibration and inertial identification, one chapter",
115
+ kind="chapter",
116
+ )
117
+ ATKESON_1986 = _doi(
118
+ "Atkeson, An, Hollerbach (1986). Estimation of inertial parameters of manipulator loads and "
119
+ "links. The International Journal of Robotics Research.",
120
+ "10.1177/027836498600500306",
121
+ "link and load inertials by least squares",
122
+ )
123
+ GAUTIER_1990 = _doi(
124
+ "Gautier, Khalil (1990). Direct calculation of minimum set of inertial parameters of serial "
125
+ "robots. IEEE Transactions on Robotics and Automation.",
126
+ "10.1109/70.56655",
127
+ "the base inertial parameters an arm can identify",
128
+ )
129
+ SWEVERS_1997 = _doi(
130
+ "Swevers, Ganseman, Tükel, De Schutter, Van Brussel (1997). Optimal robot excitation and "
131
+ "identification. IEEE Transactions on Robotics and Automation.",
132
+ "10.1109/70.631234",
133
+ "periodic excitation trajectories for dynamic identification",
134
+ )
135
+ SPONG_1987 = _doi(
136
+ "Spong (1987). Modeling and control of elastic joint robots. Journal of Dynamic Systems, "
137
+ "Measurement, and Control.",
138
+ "10.1115/1.3143860",
139
+ "joint compliance as a spring between motor and link",
140
+ )
141
+ PRATTICHIZZO_2016 = _doi(
142
+ "Prattichizzo, Trinkle (2016). Grasping. In Springer Handbook of Robotics, 2nd ed. Springer.",
143
+ "10.1007/978-3-319-32552-1_38",
144
+ "contact, friction cones and grasp force",
145
+ kind="chapter",
146
+ )
147
+
148
+ # --- belts --------------------------------------------------------------------------------------------------
149
+ ZHANG_XIA_2011 = _doi(
150
+ "Zhang, Xia (2011). Modeling and energy efficiency optimization of belt conveyors. Applied "
151
+ "Energy.",
152
+ "10.1016/j.apenergy.2011.03.015",
153
+ "a belt conveyor's resistances and drive power",
154
+ )
155
+ HE_2017 = _doi(
156
+ "He, Pang, Lodewijks (2017). Green operations of belt conveyors by means of speed control. "
157
+ "Applied Energy.",
158
+ "10.1016/j.apenergy.2016.12.017",
159
+ "a belt conveyor's dynamics under speed changes",
160
+ )
161
+
162
+ # --- cameras and markers ------------------------------------------------------------------------------------
163
+ ZHANG_2000 = _doi(
164
+ "Zhang (2000). A flexible new technique for camera calibration. IEEE Transactions on Pattern "
165
+ "Analysis and Machine Intelligence.",
166
+ "10.1109/34.888718",
167
+ "pinhole intrinsics from a planar target in several poses",
168
+ )
169
+ BROWN_1966 = Reference(
170
+ "Brown (1966). Decentering distortion of lenses. Photogrammetric Engineering.",
171
+ note="the radial and tangential (Brown-Conrady) distortion model; no stable URL",
172
+ )
173
+ HEIKKILA_1997 = _doi(
174
+ "Heikkilä, Silvén (1997). A four-step camera calibration procedure with implicit image "
175
+ "correction. IEEE Conference on Computer Vision and Pattern Recognition.",
176
+ "10.1109/CVPR.1997.609468",
177
+ "pinhole + radial and tangential distortion fitted together",
178
+ )
179
+ OTH_2013 = _doi(
180
+ "Oth, Furgale, Kneip, Siegwart (2013). Rolling shutter camera calibration. IEEE Conference on "
181
+ "Computer Vision and Pattern Recognition.",
182
+ "10.1109/CVPR.2013.179",
183
+ "the line delay of a rolling shutter, calibrated",
184
+ )
185
+ MEINGAST_2005 = Reference(
186
+ "Meingast, Geyer, Sastry (2005). Geometric models of rolling-shutter cameras. "
187
+ "arXiv:cs/0503076.",
188
+ url="https://arxiv.org/abs/cs/0503076",
189
+ kind="preprint",
190
+ note="each row exposed at its own time",
191
+ )
192
+ SCHOPS_2020 = _doi(
193
+ "Schöps, Larsson, Pollefeys, Sattler (2020). Why having 10,000 parameters in your camera model"
194
+ " is better than twelve. IEEE/CVF Conference on Computer Vision and Pattern Recognition.",
195
+ "10.1109/CVPR42600.2020.00261",
196
+ "a dense B-spline generic camera model above the parametric one",
197
+ )
198
+ KHOSHELHAM_2012 = _doi(
199
+ "Khoshelham, Elberink (2012). Accuracy and resolution of Kinect depth data for indoor mapping "
200
+ "applications. Sensors.",
201
+ "10.3390/s120201437",
202
+ "depth from disparity and its error growing with z²",
203
+ )
204
+ HERRERA_2012 = _doi(
205
+ "Herrera C., Kannala, Heikkilä (2012). Joint depth and color camera calibration with "
206
+ "distortion correction. IEEE Transactions on Pattern Analysis and Machine Intelligence.",
207
+ "10.1109/TPAMI.2012.125",
208
+ "depth bias as a spatially varying disparity distortion",
209
+ )
210
+ GARRIDO_2014 = Reference(
211
+ "Garrido-Jurado, Muñoz-Salinas, Madrid-Cuevas, Marín-Jiménez (2014). Automatic generation and "
212
+ "detection of highly reliable fiducial markers under occlusion. Pattern Recognition "
213
+ "47(6):2280-2292.",
214
+ note="the ArUco dictionaries, their ids and the detector OpenCV ships",
215
+ )
216
+ TRIGGS_2000 = Reference(
217
+ "Triggs, McLauchlan, Hartley, Fitzgibbon (2000). Bundle adjustment: a modern synthesis. Vision"
218
+ " Algorithms: Theory and Practice, LNCS 1883, Springer.",
219
+ kind="chapter",
220
+ note="robust bundle adjustment, priors and the gauge (one sticker held at CAD)",
221
+ )
222
+ STROBL_2011 = Reference(
223
+ "Strobl, Hirzinger (2011). More accurate pinhole camera calibration with imperfect planar "
224
+ "target. IEEE International Conference on Computer Vision Workshops.",
225
+ note="a target's own geometry (scale, flatness) fitted with the camera",
226
+ )
227
+
228
+ # --- spectral imaging ---------------------------------------------------------------------------------------
229
+ BURGER_2011 = _doi(
230
+ "Burger, Gowen (2011). Data handling in hyperspectral image analysis. Chemometrics and "
231
+ "Intelligent Laboratory Systems.",
232
+ "10.1016/j.chemolab.2011.04.001",
233
+ "dark and white reference reflectance calibration",
234
+ )
235
+ KRUSE_1993 = _doi(
236
+ "Kruse, Lefkoff, Boardman, Heidebrecht, Shapiro, Barloon, Goetz (1993). The spectral image "
237
+ "processing system (SIPS)—interactive visualization and analysis of imaging spectrometer data."
238
+ " Remote Sensing of Environment.",
239
+ "10.1016/0034-4257(93)90013-N",
240
+ "the spectral angle",
241
+ )
242
+ MOUROULIS_2000 = _doi(
243
+ "Mouroulis, Green, Chrien (2000). Design of pushbroom imaging spectrometers for optimum "
244
+ "recovery of spectroscopic and spatial information. Applied Optics.",
245
+ "10.1364/AO.39.002210",
246
+ "smile and keystone",
247
+ )
248
+ GUPTA_1997 = _doi(
249
+ "Gupta, Hartley (1997). Linear pushbroom cameras. IEEE Transactions on Pattern Analysis and "
250
+ "Machine Intelligence.",
251
+ "10.1109/34.615446",
252
+ "the line-scan (pushbroom) camera's geometry",
253
+ )
254
+
255
+ # --- encoders -----------------------------------------------------------------------------------------------
256
+ WIDROW_2008 = _doi(
257
+ "Widrow, Kollár (2008). Quantization Noise. Cambridge University Press.",
258
+ "10.1017/CBO9780511754661",
259
+ "an encoder as a quantiser",
260
+ kind="book",
261
+ )
262
+ MERRY_2010 = _doi(
263
+ "Merry, van de Molengraft, Steinbuch (2010). Velocity and acceleration estimation for optical "
264
+ "incremental encoders. Mechatronics.",
265
+ "10.1016/j.mechatronics.2009.06.010",
266
+ "encoder noise, quantisation and delay in velocity",
267
+ )
268
+ ZHAO_2024 = _doi(
269
+ "Zhao, Wan, Liang (2024). Automatic compensation system for eccentricity error of absolute "
270
+ "optical encoder. Review of Scientific Instruments.",
271
+ "10.1063/5.0211297",
272
+ "eccentricity as once-per-turn harmonics",
273
+ )
274
+
275
+ # --- wear and degradation -----------------------------------------------------------------------------------
276
+ ARCHARD_1953 = _doi(
277
+ "Archard (1953). Contact and rubbing of flat surfaces. Journal of Applied Physics.",
278
+ "10.1063/1.1721448",
279
+ "wear volume grows with the load carried times the distance slid",
280
+ )
281
+ FLODIN_1997 = _doi(
282
+ "Flodin, Andersson (1997). Simulation of mild wear in spur gears. Wear.",
283
+ "10.1016/S0043-1648(96)07467-4",
284
+ "Archard's law on gear teeth: the flank wear that opens backlash",
285
+ )
286
+ LU_MEEKER_1993 = _doi(
287
+ "Lu, Meeker (1993). Using degradation measures to estimate a time-to-failure distribution. "
288
+ "Technometrics.",
289
+ "10.1080/00401706.1993.10485038",
290
+ "a degradation path in usage, linear the simplest, crossing a failure threshold",
291
+ )
292
+ MEEKER_1998 = _doi(
293
+ "Meeker, Escobar, Lu (1998). Accelerated degradation tests: modeling and analysis. "
294
+ "Technometrics.",
295
+ "10.1080/00401706.1998.10485191",
296
+ "degradation paths fitted and extrapolated to a threshold",
297
+ )
298
+ WHITMORE_1995 = _doi(
299
+ "Whitmore (1995). Estimating degradation by a Wiener diffusion process subject to measurement "
300
+ "error. Lifetime Data Analysis.",
301
+ "10.1007/BF00985762",
302
+ "diffusive drift: its expected size grows as the square root of time",
303
+ )
304
+ JUNKER_1969 = _doi(
305
+ "Junker (1969). New criteria for self-loosening of fasteners under vibration. SAE Technical "
306
+ "Paper.",
307
+ "10.4271/690055",
308
+ "a mount loosening under transverse vibration",
309
+ )
310
+
311
+ # --- residuals and learned nets -----------------------------------------------------------------------------
312
+ NGUYEN_TUONG_2010 = _doi(
313
+ "Nguyen-Tuong, Peters (2010). Using model knowledge for learning inverse dynamics. IEEE "
314
+ "International Conference on Robotics and Automation.",
315
+ "10.1109/ROBOT.2010.5509858",
316
+ "a physics model plus a learned residual",
317
+ )
318
+ ZENG_2020 = _doi(
319
+ "Zeng, Song, Lee, Rodriguez, Funkhouser (2020). TossingBot: learning to throw arbitrary "
320
+ "objects with residual physics. IEEE Transactions on Robotics.",
321
+ "10.1109/TRO.2020.2988642",
322
+ "residual physics: learn what the physics estimate misses",
323
+ )
324
+ KOVALEV_2026 = Reference(
325
+ "Kovalev, Chaikovskaia, Davydenko, Gorbachev et al. (2026). Trajectory-based actuator "
326
+ "identification via differentiable simulation. arXiv:2604.10351.",
327
+ url="https://arxiv.org/abs/2604.10351",
328
+ kind="preprint",
329
+ note="a structured servo fit vs an MLP vs a residual model on held-out position error",
330
+ )
331
+ HWANGBO_2019 = _doi(
332
+ "Hwangbo, Lee, Dosovitskiy, Bellicoso, Tsounis, Koltun, Hutter (2019). Learning agile and "
333
+ "dynamic motor skills for legged robots. Science Robotics.",
334
+ "10.1126/scirobotics.aau5872",
335
+ "ANYmal's actuator net: an MLP over position error and velocity at t, t − 10 ms, t − 20 ms, 3 "
336
+ "× 32 softsign (arXiv:1901.08652)",
337
+ )
338
+ HWANGBO_2019_ARXIV = Reference(
339
+ "Hwangbo, Lee, Dosovitskiy, Bellicoso, Tsounis, Koltun, Hutter (2019). Learning agile and "
340
+ "dynamic motor skills for legged robots. arXiv:1901.08652.",
341
+ url="https://arxiv.org/abs/1901.08652",
342
+ kind="preprint",
343
+ note="the open version",
344
+ )
345
+ ZHU_2025 = Reference(
346
+ "Zhu, Tanaka, Rafeedi, Hong (2025). Cycloidal quasi-direct drive actuator designs with "
347
+ "learning-based torque estimation for legged robotics. arXiv:2410.16591.",
348
+ url="https://arxiv.org/abs/2410.16591",
349
+ kind="preprint",
350
+ note="a longer history (a 30-step GRU) when ripple or backlash matter",
351
+ )
352
+
353
+ # --- simulator documentation --------------------------------------------------------------------------------
354
+ MUJOCO_ARMATURE = Reference(
355
+ "MuJoCo (2026). XML reference: joint armature.",
356
+ url="https://mujoco.readthedocs.io/en/stable/XMLreference.html#body-joint-armature",
357
+ kind="doc",
358
+ note="the rotor's inertia reflected through the gear, as the simulator takes it",
359
+ )
360
+ MUJOCO_DCMOTOR = Reference(
361
+ "MuJoCo (2026). XML reference: the dcmotor actuator.",
362
+ url="https://mujoco.readthedocs.io/en/stable/XMLreference.html#actuator-dcmotor",
363
+ kind="doc",
364
+ note="robotparts' M5.dcmotor: electrics, heat, cogging and LuGre as MuJoCo takes them",
365
+ )
366
+ MUJOCO_CONTACT = Reference(
367
+ "MuJoCo (2026). Computation: the contact model.",
368
+ url="https://mujoco.readthedocs.io/en/stable/computation/index.html",
369
+ kind="doc",
370
+ note="soft contact with friction cones, what the twin's grasp runs on",
371
+ )
372
+
373
+ ALL = (
374
+ ARMSTRONG_1994,
375
+ OLSSON_1998,
376
+ CANUDAS_1995,
377
+ KIRCANSKI_1997,
378
+ NORDIN_2002,
379
+ TUTTLE_1996,
380
+ JAHNS_1996,
381
+ KRAUSE_2013,
382
+ KRISHNAN_2010,
383
+ SICILIANO_2009,
384
+ DH_1955,
385
+ HAYATI_1983,
386
+ OKAMURA_1996,
387
+ HOLLERBACH_WAMPLER_1996,
388
+ HOLLERBACH_2016,
389
+ ATKESON_1986,
390
+ GAUTIER_1990,
391
+ SWEVERS_1997,
392
+ SPONG_1987,
393
+ PRATTICHIZZO_2016,
394
+ ZHANG_XIA_2011,
395
+ HE_2017,
396
+ ZHANG_2000,
397
+ BROWN_1966,
398
+ HEIKKILA_1997,
399
+ OTH_2013,
400
+ MEINGAST_2005,
401
+ SCHOPS_2020,
402
+ KHOSHELHAM_2012,
403
+ HERRERA_2012,
404
+ GARRIDO_2014,
405
+ TRIGGS_2000,
406
+ STROBL_2011,
407
+ BURGER_2011,
408
+ KRUSE_1993,
409
+ MOUROULIS_2000,
410
+ GUPTA_1997,
411
+ WIDROW_2008,
412
+ MERRY_2010,
413
+ ZHAO_2024,
414
+ ARCHARD_1953,
415
+ FLODIN_1997,
416
+ LU_MEEKER_1993,
417
+ MEEKER_1998,
418
+ WHITMORE_1995,
419
+ JUNKER_1969,
420
+ NGUYEN_TUONG_2010,
421
+ ZENG_2020,
422
+ KOVALEV_2026,
423
+ HWANGBO_2019,
424
+ HWANGBO_2019_ARXIV,
425
+ ZHU_2025,
426
+ MUJOCO_ARMATURE,
427
+ MUJOCO_DCMOTOR,
428
+ MUJOCO_CONTACT,
429
+ )
@@ -0,0 +1 @@
1
+ """Sensor types by type folder (PEP 0004): encoder/, camera/, rgbd/ (the depth camera), hyperspectral_camera/."""