Skip to content

Commit d141e13

Browse files
Improve the RemoteNode.load_configuration() docs (#477)
Spell out how it works and link to PdoBase.read() Moreover, add return annotation to make sure that's included in the rendered docs.
1 parent 503918c commit d141e13

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

canopen/node/remote.py

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,16 @@ def __load_configuration_helper(self, index, subindex, name, value):
141141
index, subindex, e)
142142
raise
143143

144-
def load_configuration(self):
145-
''' Load the configuration of the node from the object dictionary.'''
144+
def load_configuration(self) -> None:
145+
"""Load the configuration of the node from the Object Dictionary.
146+
147+
Iterate through all objects in the Object Dictionary and download the
148+
values to the remote node via SDO.
149+
Then, to avoid PDO mapping conflicts, read back (upload) the PDO
150+
configuration via SDO.
151+
152+
:see-also: :meth:`canopen.pdo.PdoBase.read`
153+
"""
146154
for obj in self.object_dictionary.values():
147155
if isinstance(obj, ODRecord) or isinstance(obj, ODArray):
148156
for subobj in obj.values():

0 commit comments

Comments
 (0)