Skip to content

Commit

Permalink
Fixed some typos
Browse files Browse the repository at this point in the history
  • Loading branch information
grodansparadis committed Dec 18, 2024
1 parent a4a6f7a commit 019feb1
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 11 deletions.
2 changes: 1 addition & 1 deletion _sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* [VSCP over a serial channel (RS-232)](./vscp_over_a_serial_channel_rs-232.md)
* [VSCP Level I over RS-485/RS-422](./vscp_level_i_over_rs-485_rs-422.md)
* [VSCP over LoRa](./vscp_over_lora.md)
* [VSCP over Bluetooth LE (BLE)](./vscp_over_bt_ble.md)
* [VSCP over Bluetooth LE (BLE)](./vscp_over_bt_ble.md)
* [VSCP over Bluetooth mesh](./vscp_over_bt_mesh.md)
* [VSCP over IEEE 802.15.4](./vscp_over_ieee_802.15.4.md)
* [VSCP Droplet model](./vscp_droplet_model.md)
Expand Down
11 changes: 7 additions & 4 deletions class1.protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ All other events are optional except for **one exception**. All nodes should sen
VSCP_TYPE_PROTOCOL_GENERAL
```
General Event.

You can use this event for anything you want. It's a general event, so it can be used for anything. The data format and the use is all up to your needs. It is important of course that you document the data format and the use of the event in your documentation and in the MDF for the device. But of course if there is an existing event that does the job you want, you should probably use that one instead of this one.
----

## Type=1 (0x01) - Segment Controller Heartbeat. :id=type1
Expand Down Expand Up @@ -549,6 +551,7 @@ Request from a node to program a data block that has been uploaded and confirmed
| 3 | LSB of block number. |

Sent only if the block was successfully received and confirmed by checking the crc for the full block. The block number is the number of the block that was sent in the last block data event.

----

## Type=20 (0x14) - ACK program data block. :id=type20
Expand Down Expand Up @@ -1168,7 +1171,7 @@ VSCP_TYPE_PROTOCOL_START_BLOCK_NACK

Part of the VSCP boot-loader functionality. This is the negative response after a node received
a [CLASS1.PROTOCOL, Type=15 (Start block data transfer)](./class1.protocol.md#type15) event (a part of a block).
It is sent by the node as a validation that it can handle the block data transfer.
It is sent by the node as a validation that it can't handle the block data transfer.

----

Expand All @@ -1179,7 +1182,7 @@ VSCP_TYPE_PROTOCOL_BLOCK_CHUNK_ACK
**Not mandatory** Only needed if a VSCP boot loader algorithm is used.

Part of the VSCP boot-loader functionality. This is the positive response after a node received
a [CLASS1.PROTOCOL, Type=16 (Start Block data transfer)](./class1.protocol.md#type16) event (a part of a block).
a [CLASS1.PROTOCOL, Type=16 (Block data)](./class1.protocol.md#type16) event (a part of a block).
It is sent by the node as a validation that it can handle the block data transfer.

----
Expand All @@ -1191,8 +1194,8 @@ VSCP_TYPE_PROTOCOL_BLOCK_CHUNK_NACK
**Not mandatory** Only needed if a VSCP boot loader algorithm is used.

Part of the VSCP boot-loader functionality. This is the negative response after a node received
a [CLASS1.PROTOCOL, Type=16 (Start Block data transfer)](./class1.protocol.md#type16) event (a part of a block).
It is sent by the node as a validation that it can handle the block data transfer.
a [CLASS1.PROTOCOL, Type=16 (Block dasta)](./class1.protocol.md#type16) event (a part of a block).
It is sent by the node as a validation that it can't handle the block data transfer.

----

Expand Down
11 changes: 7 additions & 4 deletions class2.level1.protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ VSCP_TYPE_PROTOCOL_GENERAL
```
General Event.

You can use this event for anything you want. It's a general event, so it can be used for anything. The data format and the use is all up to your needs. It is important of course that you document the data format and the use of the event in your documentation and in the MDF for the device. But of course if there is an existing event that does the job you want, you should probably use that one instead of this one.


----

Expand Down Expand Up @@ -683,6 +685,7 @@ Request from a node to program a data block that has been uploaded and confirmed
Sent only if the block was successfully received and confirmed by checking the crc for the full block. The block number is the number of the block that was sent in the last block data event.



----


Expand Down Expand Up @@ -1404,7 +1407,7 @@ VSCP_TYPE_PROTOCOL_START_BLOCK_NACK

Part of the VSCP boot-loader functionality. This is the negative response after a node received
a [CLASS1.PROTOCOL, Type=15 (Start block data transfer)](./class1.protocol.md#type15) event (a part of a block).
It is sent by the node as a validation that it can handle the block data transfer.
It is sent by the node as a validation that it can't handle the block data transfer.



Expand All @@ -1419,7 +1422,7 @@ VSCP_TYPE_PROTOCOL_BLOCK_CHUNK_ACK
**Not mandatory** Only needed if a VSCP boot loader algorithm is used.

Part of the VSCP boot-loader functionality. This is the positive response after a node received
a [CLASS1.PROTOCOL, Type=16 (Start Block data transfer)](./class1.protocol.md#type16) event (a part of a block).
a [CLASS1.PROTOCOL, Type=16 (Block data)](./class1.protocol.md#type16) event (a part of a block).
It is sent by the node as a validation that it can handle the block data transfer.


Expand All @@ -1435,8 +1438,8 @@ VSCP_TYPE_PROTOCOL_BLOCK_CHUNK_NACK
**Not mandatory** Only needed if a VSCP boot loader algorithm is used.

Part of the VSCP boot-loader functionality. This is the negative response after a node received
a [CLASS1.PROTOCOL, Type=16 (Start Block data transfer)](./class1.protocol.md#type16) event (a part of a block).
It is sent by the node as a validation that it can handle the block data transfer.
a [CLASS1.PROTOCOL, Type=16 (Block dasta)](./class1.protocol.md#type16) event (a part of a block).
It is sent by the node as a validation that it can't handle the block data transfer.



Expand Down
4 changes: 2 additions & 2 deletions variables.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<var>
<creation-time>2024-12-16 22:06:01</creation-time>
<document-version>1.14.23</document-version>
<creation-time>2024-12-18 16:42:33</creation-time>
<document-version>1.14.24</document-version>
</var>
1 change: 1 addition & 0 deletions vscp_specification_history.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

| Date | By | Description |
| ---------- | ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|2024-12-18| AKHE | Fixing typos |
|2024-12-16| AKHE | VSCP_TYPE_PROTOCOL_BOOT_LOADER_CHECK added |
|2024-11-28| AKHE | Fixed non working links |
|2024-11-28| AKHE | Changed name for tokens VSCP_TYPE_PROTOCOL_START_BLOCK_ACK, VSCP_TYPE_PROTOCOL_START_BLOCK_NACK rename to VSCP_TYPE_PROTOCOL_CHUNK_ACK, VSCP_TYPE_PROTOCOL_CHUNK_NACK |
Expand Down

0 comments on commit 019feb1

Please sign in to comment.