Documentation for wireless blocks and datatypes

content/en/docs/2024.5/Reference/Blocks/wireless/_index.md

@@ -1,5 +1,5 @@
 ---
 title: "Wireless"
 linkTitle: "Wireless"
-description: "Blocks related to working with wireless connections."
+description: "Blocks related to moving the execution."
 ---

content/en/docs/2024.5/Reference/Blocks/wireless/wireless-receiver/_index.md

@@ -1,5 +1,5 @@
 ---
-title: "Wireless Receiever"
+title: "Wireless Receiver"
 linkTitle: "Wireless Receiver"
-description: "Blocks related to receiving wireless connections."
+description: "Blocks related to receiving an execution."
 ---

content/en/docs/2024.5/Reference/Blocks/wireless/wireless-receiver/wireless-receiver-block.md

@@ -1,19 +1,53 @@
 ---
-title: "Wireless Receiever"
-linkTitle: "Wireless Receiever"
-description: "Receieves a wireless connection."
+title: "Wireless Receiver"
+linkTitle: "Wireless Receiver"
+description: "Receives executions."
 ---
 
+{{< figure src="/blocks/wireless-receiver-block-icon.png" alt="Icon" class="block-icon" >}}
+
 # {{% param title %}}
 
 <p class="namespace">(Cortex.Blocks.Wireless.WirelessReceiver.WirelessReceiverBlock)</p>
 
 ## Description
 
+Receives executions from [Wireless Sender][Wireless Sender Block] blocks.
+
+The block has no block specific properties, but it does have the `Description` property that is common to all blocks. This allows users to give each block a description; selection of the [Wireless Receiver][Wireless Receiver Block Property] block in [Wireless Sender][Wireless Sender Block] blocks is done based on description so it should be set to something appropriate and unique.
+
 ## Examples
 
+No examples for the block.
+
+## Properties
+
+No properties for the block, other than the `Description` property that is common to all blocks.
+
 ## Exceptions
 
 No exceptions are thrown by the block.
 
 ## Remarks
+
+### Wireless Block Scope
+
+The Wireless blocks are scoped to the workspace that they are placed in; as a result, [Wireless Sender][Wireless Sender Block] blocks will only be able to select [Wireless Receiver][Wireless Receiver Block] blocks that are placed in the same workspace as itself.
+
+### Multiple Wireless Senders with same Wireless Receiver
+
+Multiple [Wireless Sender][Wireless Sender Block] blocks can send executions to the same [Wireless Receiver][Wireless Receiver Block] block.
+
+### Multiple Wireless Receivers with same Description
+
+If there are multiple [Wireless Receiver][Wireless Receiver Block] blocks with the same Description in the same scope, the [Guid][] of those blocks will be shown in the dropdown entries of the [Wireless Receiver Block][Wireless Receiver Block Property] property's [Literal][Literal Editor] editor in the [Wireless Sender][Wireless Sender Block] block.
+
+### Known Limitations
+
+None
+
+[Guid]: {{< url path="Cortex.Reference.DataTypes.Other.Guid.MainDoc" >}}
+[Literal Editor]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.LiteralEditor.MainDoc" >}}
+[Wireless Sender Block]: {{< url path="Cortex.Reference.Blocks.Wireless.WirelessSender.WirelessSender.MainDoc" >}}
+[Wireless Receiver Block]: {{< url path="Cortex.Reference.Blocks.Wireless.WirelessReceiver.WirelessReceiver.MainDoc" >}}
+[Wireless Receiver Block Property]: {{< url path="Cortex.Reference.Blocks.Wireless.WirelessSender.WirelessSender.WirelessReceiverProperty" >}}

content/en/docs/2024.5/Reference/Blocks/wireless/wireless-sender/_index.md

@@ -1,5 +1,5 @@
 ---
 title: "Wireless Sender"
 linkTitle: "Wireless Sender"
-description: "Blocks related to sending wireless connections."
+description: "Blocks related to sending an execution."
 ---

content/en/docs/2024.5/Reference/Blocks/wireless/wireless-sender/wireless-sender-block.md

@@ -1,19 +1,88 @@
 ---
 title: "Wireless Sender"
 linkTitle: "Wireless Sender"
-description: "Sends a wireless connection."
+description: "Sends an execution to a specific block."
 ---
 
+{{< figure src="/blocks/wireless-sender-block-icon.png" alt="Icon" class="block-icon" >}}
+
 # {{% param title %}}
 
 <p class="namespace">(Cortex.Blocks.Wireless.WirelessSender.WirelessSenderBlock)</p>
 
 ## Description
 
+Sends the execution to the specified [Wireless Receiver][Wireless Receiver Block] block.
+
 ## Examples
 
+### Sending an Execution to a Wireless Receiver
+
+This example is for a flow containing two [Wireless Receiver][Wireless Receiver Block] blocks with descriptions set to `Receiver 1` and `Receiver 2` as well as a [Wireless Sender][Wireless Sender Block] block with the following properties:
+
+#### Properties
+
+| Property           | Value                     | Notes                                    |
+|--------------------|---------------------------|------------------------------------------|
+| [Wireless Receiver Block][Wireless Receiver Property] | [Wireless Receiver Block][Wireless Receiver Property], with value `Receiver 1` | [Wireless Receiver Block][Wireless Receiver Property] is of type [WirelessReceiverBlockReference][] |
+
+#### Result
+
+Once an execution is started and it reaches the [Wireless Sender][Wireless Sender Block] block the execution will jump to the [Wireless Receiver][Wireless Receiver Block] block with description `Receiver 1`.
+
+## Properties
+
+### Wireless Receiver Block
+
+The [Wireless Receiver][Wireless Receiver Block] block that the execution will be sent to.
+
+The [Literal Editor][] is the only editor available for this property, and it provides the developer a list of all available [Wireless Receiver][Wireless Receiver Block] blocks in the current workspace to choose from.
+
+| | |
+|--------------------|---------------------------|
+| Data Type | [WirelessReceiverBlockReference][] |
+| Property Type | [Input][] |
+| Is [Advanced][] | `false` |
+| Default Editor | [Literal][Literal Editor] |
+| Default Value | No value (defaults to `null`) |
+
 ## Exceptions
 
-No exceptions are thrown by the block.
+| Name | Description |
+|------|-------------|
+| [WirelessReceiverBlockNotFoundException][] | Thrown when the specified [Wireless Receiver][Wireless Receiver Property] block has been deleted. See [Wireless Receiver Block Not Found][WirelessReceiverExceptionBlockNotFound]. |
+| | Thrown when [Wireless Receiver][Wireless Receiver Property] block has not been selected. See [Wireless Receiver Property Empty][WirelessReceiverExceptionPropertyEmpty].  |
 
 ## Remarks
+
+### Wireless Block Scope
+
+The Wireless blocks are scoped to the workspace that they are placed in; as a result, [Wireless Sender][Wireless Sender Block] blocks will only be able to select [Wireless Receiver][Wireless Receiver Block] blocks that are placed in the same workspace as itself.
+
+### Multiple Wireless Senders with same Wireless Receiver
+
+Multiple [Wireless Sender][Wireless Sender Block] blocks can send executions to the same [Wireless Receiver][Wireless Receiver Block] block.
+
+### Multiple Wireless Receivers with same Description
+
+If there are multiple [Wireless Receiver][Wireless Receiver Block] blocks with the same Description in the same scope, the [Guid][] of those blocks will be shown in the dropdown entries of the [Literal][Literal Editor] editor of the [Wireless Receiver Block][Wireless Receiver Property] property.
+
+### Known Limitations
+
+#### The Wireless Receiver Block Property can only use the Literal Editor
+
+The Literal Editor is the only editor available for the [Wireless Receiver Block Property][Wireless Receiver Property]
+
+In future this limitation may be removed.
+
+[Guid]: {{< url path="Cortex.Reference.DataTypes.Other.Guid.MainDoc" >}}
+[Wireless Receiver Property]: {{< ref "#wireless-receiver-block" >}}
+[Literal Editor]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.LiteralEditor.MainDoc" >}}
+[Wireless Sender Block]: {{< url path="Cortex.Reference.Blocks.Wireless.WirelessSender.WirelessSender.MainDoc" >}}
+[Wireless Receiver Block]: {{< url path="Cortex.Reference.Blocks.Wireless.WirelessReceiver.WirelessReceiver.MainDoc" >}}
+[WirelessReceiverBlockReference]: {{< url path="Cortex.Reference.DataTypes.Wireless.WirelessReceiverBlockReference.MainDoc" >}}
+[WirelessReceiverBlockNotFoundException]: {{< url path="Cortex.Reference.Exceptions.Wireless.WirelessReceiverBlockNotFoundException.MainDoc" >}}
+[WirelessReceiverExceptionBlockNotFound]: {{< url path="Cortex.Reference.Exceptions.Wireless.WirelessReceiverBlockNotFoundException.BlockNotFound" >}}
+[WirelessReceiverExceptionPropertyEmpty]: {{< url path="Cortex.Reference.Exceptions.Wireless.WirelessReceiverBlockNotFoundException.PropertyEmpty" >}}
+[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}}
+[Advanced]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.AdvancedProperties.MainDoc" >}}

content/en/docs/2024.5/Reference/Exceptions/wireless/_index.md

@@ -0,0 +1,5 @@
+---
+title: "Wireless"
+linkTitle: "Wireless"
+description: "Exceptions related to issues with wireless blocks"
+---

content/en/docs/2024.5/Reference/Exceptions/wireless/wireless-receiver-block-not-found-exception.md

@@ -0,0 +1,142 @@
+---
+title: "WirelessReceiverBlockNotFoundException"
+linkTitle: "WirelessReceiverBlockNotFoundException"
+description: "The exception thrown when a wireless receiver block could not be found."
+---
+
+# {{% param title %}}
+
+<p class="namespace">(Cortex.Exceptions.Wireless.WirelessReceiverBlockNotFoundException)</p>
+
+## Description
+
+The exception thrown when a [Wireless Receiver][Wireless Receiver Block] block could not be found.
+
+There are multiple reasons that this exception can be thrown:
+
+- [Wireless Receiver Block Not Found][WirelessReceiverExceptionBlockNotFound]
+- [Wireless Receiver Property Empty][WirelessReceiverExceptionPropertyEmpty]
+
+## Reasons
+
+### Wireless Receiver Block Not Found {#100}
+
+A [Category][] of `NotFound` and an [Error Code][] of `100` indicates that the selected [Wireless Receiver][Wireless Receiver Block] block was deleted or does not exist.
+
+#### Message Format
+
+```json
+"The 'Wireless Receiver Block' provided could not be found.
+Please click the HelpLink for more information on how to fix this."
+```
+
+#### How to fix
+
+Ensure the correct [Wireless Receiver][Wireless Receiver Block] block is selected.
+
+### Wireless Receiver Property Empty {#101}
+
+A [Category][] of `NotFound` and an [Error Code][] of `101` indicates that a [Wireless Receiver][Wireless Receiver Block] block has not been selected.
+
+#### Message Format
+
+```json
+"'Wireless Receiver Block' is empty; it must be provided a value.
+Please click the HelpLink for more information on how to fix this."
+```
+
+#### How to fix
+
+Ensure a [Wireless Receiver][Wireless Receiver Block] block is selected.
+
+## Properties
+
+### Exception Type
+
+The type of the exception (i.e. `WirelessReceiverBlockNotFoundException`)
+
+| | |
+|-----------|------------|
+| Data Type | [String][] |
+
+### Message
+
+The exception message, providing information about the exception that occurred.
+
+| | |
+|-----------|------------|
+| Data Type | [String][] |
+
+### Category
+
+The category of the exception, which is used to categorise an exception if there are multiple reasons that the exception can occur.
+
+For `WirelessReceiverBlockNotFoundException` there are the following categories:
+
+- `NotFound`
+
+| | |
+|-----------|------------|
+| Data Type | [String][] |
+
+### Error Code
+
+The error code for the exception, which is used to indicate the reason that the exception occurred, if there are multiple reasons that the exception can occur.
+
+For `WirelessReceiverBlockNotFoundException` there are the following error codes:
+
+- [100][WirelessReceiverBlockNotFound] - indicates that the [Wireless Receiver][Wireless Receiver Block] block could not be found
+- [101][WirelessReceiverPropertyEmpty] - indicates that the [Wireless Receiver Block][Wireless Receiver Block Property] property was empty
+
+| | |
+|-----------|---------------------------|
+| Data Type | [WirelessReceiverNotFoundErrorCode][WirelessReceiverNotFoundErrorCode] |
+
+### Help Link
+
+The URL for the relevant section of this exception's help page.
+
+| | |
+|-----------|------------|
+| Data Type | [String][] |
+
+## Remarks
+
+### Known Limitations
+
+None
+
+## See Also
+
+### Related Data Types
+
+* [String][]
+* [WirelessReceiverNotFoundErrorCode][]
+
+### Related Concepts
+
+* [Exceptions][]
+
+### Related Blocks
+
+* [Wireless Sender Block][]
+
+### External Documentation
+
+None
+
+[Category]: {{< ref "#category">}}
+[Error Code]: {{< ref "#error-code">}}
+[WirelessReceiverBlockNotFound]: {{< ref "#100">}}
+[WirelessReceiverPropertyEmpty]: {{< ref "#101">}}
+
+[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}}
+
+[Exceptions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.MainDoc" >}}
+
+[Wireless Sender Block]: {{< url path="Cortex.Reference.Blocks.Wireless.WirelessSender.WirelessSender.MainDoc" >}}
+[Wireless Receiver Block]: {{< url path="Cortex.Reference.Blocks.Wireless.WirelessReceiver.WirelessReceiver.MainDoc" >}}
+[WirelessReceiverExceptionBlockNotFound]: {{< url path="Cortex.Reference.Exceptions.Wireless.WirelessReceiverBlockNotFoundException.BlockNotFound" >}}
+[WirelessReceiverExceptionPropertyEmpty]: {{< url path="Cortex.Reference.Exceptions.Wireless.WirelessReceiverBlockNotFoundException.PropertyEmpty" >}}
+[WirelessReceiverNotFoundErrorCode]: {{< url path="Cortex.Reference.DataTypes.Wireless.WirelessReceiverBlockNotFoundErrorCode.MainDoc" >}}
+[Wireless Receiver Block Property]: {{< url path="Cortex.Reference.Blocks.Wireless.WirelessSender.WirelessSender.WirelessReceiverProperty" >}}

content/en/docs/2024.5/Reference/data-types/wireless/_index.md

@@ -0,0 +1,6 @@
+---
+title: "Wireless"
+linkTitle: "Wireless"
+description: "Data types used for working with Wireless blocks."
+weight: 1
+---