nikon/CANopenNode
1
0
Fork 0
Code Activity Actions

Minor corrections in documentation.

Browse source
This commit is contained in:
Janez 2020-04-03 11:43:14 +02:00
parent ffd5027cb2
commit 43f86073ee
9 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
301/CO_Emergency.h
View file

@ -449,7 +449,7 @@ void CO_EM_initCallbackRx(
* @param NMTisPreOrOperational True if this node is NMT_PRE_OPERATIONAL or NMT_OPERATIONAL.
* @param timeDifference_us Time difference from previous function call in [microseconds].
* @param emInhTime _Inhibit time EMCY_ in [100*us] (object dictionary, index 0x1015).
* @param timerNext_us [out] info to OS - see CO_process().
* @param [out] timerNext_us info to OS - see CO_process().
*/
void CO_EM_process(
CO_EMpr_t *emPr,

2
301/CO_HBconsumer.h
View file

@ -291,7 +291,7 @@ void CO_HBconsumer_initCallbackRemoteReset(
* @param HBcons This object.
* @param NMTisPreOrOperational True if this node is NMT_PRE_OPERATIONAL or NMT_OPERATIONAL.
* @param timeDifference_us Time difference from previous function call in [microseconds].
* @param timerNext_us [out] info to OS - see CO_process().
* @param [out] timerNext_us info to OS - see CO_process().
*/
void CO_HBconsumer_process(
CO_HBconsumer_t *HBcons,

2
301/CO_NMT_Heartbeat.h
View file

@ -259,7 +259,7 @@ void CO_NMT_initCallbackChanged(
* @param errorBehavior pointer to _Error behavior_ array (object dictionary, index 0x1029).
* Object controls, if device should leave NMT operational state.
* Length of array must be 6. If pointer is NULL, no calculation is made.
* @param timerNext_us [out] info to OS - see CO_process().
* @param [out] timerNext_us info to OS - see CO_process().
*
* @return #CO_NMT_reset_cmd_t
*/

2
301/CO_PDO.h
View file

@ -381,7 +381,7 @@ void CO_RPDO_process(CO_RPDO_t *RPDO, bool_t syncWas);
* @param TPDO This object.
* @param syncWas True, if CANopen SYNC message was just received or transmitted.
* @param timeDifference_us Time difference from previous function call in [microseconds].
* @param timerNext_us [out] info to OS - see CO_process_SYNC_PDO().
* @param [out] timerNext_us info to OS - see CO_process_SYNC_PDO().
*/
void CO_TPDO_process(
CO_TPDO_t *TPDO,

2
301/CO_SDOserver.h
View file

@ -797,7 +797,7 @@ void CO_SDO_initCallbackPre(
* @param NMTisPreOrOperational Different than zero, if #CO_NMT_internalState_t is
* NMT_PRE_OPERATIONAL or NMT_OPERATIONAL.
* @param timeDifference_us Time difference from previous function call in [microseconds].
* @param timerNext_us [out] info to OS - see CO_process().
* @param [out] timerNext_us info to OS - see CO_process().
*
* @return 0: SDO server is idle.
* @return 1: SDO server is in transfer state.

2
301/CO_SYNC.h
View file

@ -146,7 +146,7 @@ CO_ReturnError_t CO_SYNC_init(
* @param timeDifference_us Time difference from previous function call in [microseconds].
* @param ObjDict_synchronousWindowLength _Synchronous window length_ variable from
* Object dictionary (index 0x1007).
* @param timerNext_us [out] info to OS - see CO_process_SYNC_PDO().
* @param [out] timerNext_us info to OS - see CO_process_SYNC_PDO().
*
* @return 0: No special meaning.
* @return 1: New SYNC message recently received or was just transmitted.

4
305/CO_LSSmaster.h
View file

@ -353,7 +353,7 @@ CO_LSSmaster_return_t CO_LSSmaster_ActivateBit(
* @param LSSmaster This object.
* @param timeDifference_us Time difference from previous function call in
* [microseconds]. Zero when request is started.
* @param lssAddress [out] read result when function returns successfully
* @param [out] lssAddress read result when function returns successfully
* @return #CO_LSSmaster_ILLEGAL_ARGUMENT, #CO_LSSmaster_INVALID_STATE,
* #CO_LSSmaster_WAIT_SLAVE, #CO_LSSmaster_OK, #CO_LSSmaster_TIMEOUT
*/
@ -376,7 +376,7 @@ CO_LSSmaster_return_t CO_LSSmaster_InquireLssAddress(
* @param LSSmaster This object.
* @param timeDifference_us Time difference from previous function call in
* [microseconds]. Zero when request is started.
* @param nodeId [out] read result when function returns successfully
* @param [out] nodeId read result when function returns successfully
* @return #CO_LSSmaster_ILLEGAL_ARGUMENT, #CO_LSSmaster_INVALID_STATE,
* #CO_LSSmaster_WAIT_SLAVE, #CO_LSSmaster_OK, #CO_LSSmaster_TIMEOUT
*/

6
305/CO_LSSslave.h
View file

@ -301,8 +301,8 @@ CO_ReturnError_t CO_LSSslave_init(
* @param LSSslave This object.
* @param activeBitRate Currently active bit rate
* @param activeNodeId Currently active node ID
* @param pendingBitRate [out] Requested bit rate
* @param pendingNodeId [out] Requested node id
* @param [out] pendingBitRate Requested bit rate
* @param [out] pendingNodeId Requested node id
*/
void CO_LSSslave_process(
CO_LSSslave_t *LSSslave,
@ -333,7 +333,7 @@ CO_LSS_state_t CO_LSSslave_getState(
*
* @param LSSslave This object.
* @param timeDifference_us The amount of time elapsed since the last call
* @param LEDon [out] LED state
* @param [out] LEDon LED state
*
* @return true if LSS is involved (unconfigured node or selected node)
*/

4
README.md
View file

@ -44,7 +44,7 @@ Characteristics
- [Multithreaded, real-time](#flowchart-of-a-typical-canopennode-implementation)
- [Object Dictionary editor](#object-dictionary-editor)
- Non-volatile storage.
- [Power saving possible](#power-saving) (experimental)
- [Power saving possible](#power-saving)
- [Bootloader possible](https://github.com/CANopenNode/CANopenNode/issues/111) (for firmware update)
@ -231,7 +231,7 @@ then NMT operational state is not allowed.
### Power saving
All CANopen objects calculates next timer info for OS. Calculation is based on
various timers which expire in known time. Can be used to put microcontroller
into sleep and wake at the calculated time. This is experimental.
into sleep and wake at the calculated time.
Change Log