candbc_clear
Purpose:
-
Instruct the CanDbc Driver to clear the list of messages it is sending.
Enter:
-
candbc_clear [-c=n] [name=register_name] [id=message]
Where:
|
-c |
Optional. Specify the channel number to clear. The default value of 2 clears both channels. |
| name | Optional. Specify a register name if the assigned CanDbc register name is different from the default name. Use this option to ensure the correct ‘CanDbc’ task sends the message. |
| id | Optional. Specify the message ID or name to clear. If this argument is being used, the -c option must also be used to specify the channel list from where to remove the message. |
Example:
-
candbc_clear
Stop sending all messages on the default channel as long as CanDbc was not started with the ‘name=’ argument.candbc_clear -c=1
Stop sending all messages on the second channel.candbc_clear name=CanDbc2
Stop sending all messages on the default channel with a CanDbc task started with the register name “CanDbc2”.candbc_clear name=CanDbc2 -c=0 id=23456789
Stop sending the message with ID 23456789 on channel 1 with a CanDbc task started with the register name “CanDbc2”.candbc_clear name=CanDbc2 -c=1 id=can_message1
Stop sending the message with the name “can_message1” on channel 2 with a CanDbc task started with the register name “CanDbc2”.
Notes:
-
If the id option is used without -c, it clears the specified message on the default channels.