Skip to content

Commit 713436f

Browse files
Cortex-ModestasTCortex-ModestasT
authored
Documentation for wireless blocks and datatypes
1 parent c62f504 commit 713436f

File tree

13 files changed

+507
-14
lines changed

13 files changed

+507
-14
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
22
title: "Wireless"
33
linkTitle: "Wireless"
4-
description: "Blocks related to working with wireless connections."
4+
description: "Blocks related to moving the execution."
55
---

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Wireless Receiever"
2+
title: "Wireless Receiver"
33
linkTitle: "Wireless Receiver"
4-
description: "Blocks related to receiving wireless connections."
4+
description: "Blocks related to receiving an execution."
55
---

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

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,53 @@
11
---
2-
title: "Wireless Receiever"
3-
linkTitle: "Wireless Receiever"
4-
description: "Receieves a wireless connection."
2+
title: "Wireless Receiver"
3+
linkTitle: "Wireless Receiver"
4+
description: "Receives executions."
55
---
66

7+
{{< figure src="/blocks/wireless-receiver-block-icon.png" alt="Icon" class="block-icon" >}}
8+
79
# {{% param title %}}
810

911
<p class="namespace">(Cortex.Blocks.Wireless.WirelessReceiver.WirelessReceiverBlock)</p>
1012

1113
## Description
1214

15+
Receives executions from [Wireless Sender][Wireless Sender Block] blocks.
16+
17+
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.
18+
1319
## Examples
1420

21+
No examples for the block.
22+
23+
## Properties
24+
25+
No properties for the block, other than the `Description` property that is common to all blocks.
26+
1527
## Exceptions
1628

1729
No exceptions are thrown by the block.
1830

1931
## Remarks
32+
33+
### Wireless Block Scope
34+
35+
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.
36+
37+
### Multiple Wireless Senders with same Wireless Receiver
38+
39+
Multiple [Wireless Sender][Wireless Sender Block] blocks can send executions to the same [Wireless Receiver][Wireless Receiver Block] block.
40+
41+
### Multiple Wireless Receivers with same Description
42+
43+
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.
44+
45+
### Known Limitations
46+
47+
None
48+
49+
[Guid]: {{< url path="Cortex.Reference.DataTypes.Other.Guid.MainDoc" >}}
50+
[Literal Editor]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.LiteralEditor.MainDoc" >}}
51+
[Wireless Sender Block]: {{< url path="Cortex.Reference.Blocks.Wireless.WirelessSender.WirelessSender.MainDoc" >}}
52+
[Wireless Receiver Block]: {{< url path="Cortex.Reference.Blocks.Wireless.WirelessReceiver.WirelessReceiver.MainDoc" >}}
53+
[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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
22
title: "Wireless Sender"
33
linkTitle: "Wireless Sender"
4-
description: "Blocks related to sending wireless connections."
4+
description: "Blocks related to sending an execution."
55
---

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

Lines changed: 71 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,88 @@
11
---
22
title: "Wireless Sender"
33
linkTitle: "Wireless Sender"
4-
description: "Sends a wireless connection."
4+
description: "Sends an execution to a specific block."
55
---
66

7+
{{< figure src="/blocks/wireless-sender-block-icon.png" alt="Icon" class="block-icon" >}}
8+
79
# {{% param title %}}
810

911
<p class="namespace">(Cortex.Blocks.Wireless.WirelessSender.WirelessSenderBlock)</p>
1012

1113
## Description
1214

15+
Sends the execution to the specified [Wireless Receiver][Wireless Receiver Block] block.
16+
1317
## Examples
1418

19+
### Sending an Execution to a Wireless Receiver
20+
21+
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:
22+
23+
#### Properties
24+
25+
| Property | Value | Notes |
26+
|--------------------|---------------------------|------------------------------------------|
27+
| [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][] |
28+
29+
#### Result
30+
31+
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`.
32+
33+
## Properties
34+
35+
### Wireless Receiver Block
36+
37+
The [Wireless Receiver][Wireless Receiver Block] block that the execution will be sent to.
38+
39+
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.
40+
41+
| | |
42+
|--------------------|---------------------------|
43+
| Data Type | [WirelessReceiverBlockReference][] |
44+
| Property Type | [Input][] |
45+
| Is [Advanced][] | `false` |
46+
| Default Editor | [Literal][Literal Editor] |
47+
| Default Value | No value (defaults to `null`) |
48+
1549
## Exceptions
1650

17-
No exceptions are thrown by the block.
51+
| Name | Description |
52+
|------|-------------|
53+
| [WirelessReceiverBlockNotFoundException][] | Thrown when the specified [Wireless Receiver][Wireless Receiver Property] block has been deleted. See [Wireless Receiver Block Not Found][WirelessReceiverExceptionBlockNotFound]. |
54+
| | Thrown when [Wireless Receiver][Wireless Receiver Property] block has not been selected. See [Wireless Receiver Property Empty][WirelessReceiverExceptionPropertyEmpty]. |
1855

1956
## Remarks
57+
58+
### Wireless Block Scope
59+
60+
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.
61+
62+
### Multiple Wireless Senders with same Wireless Receiver
63+
64+
Multiple [Wireless Sender][Wireless Sender Block] blocks can send executions to the same [Wireless Receiver][Wireless Receiver Block] block.
65+
66+
### Multiple Wireless Receivers with same Description
67+
68+
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.
69+
70+
### Known Limitations
71+
72+
#### The Wireless Receiver Block Property can only use the Literal Editor
73+
74+
The Literal Editor is the only editor available for the [Wireless Receiver Block Property][Wireless Receiver Property]
75+
76+
In future this limitation may be removed.
77+
78+
[Guid]: {{< url path="Cortex.Reference.DataTypes.Other.Guid.MainDoc" >}}
79+
[Wireless Receiver Property]: {{< ref "#wireless-receiver-block" >}}
80+
[Literal Editor]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.LiteralEditor.MainDoc" >}}
81+
[Wireless Sender Block]: {{< url path="Cortex.Reference.Blocks.Wireless.WirelessSender.WirelessSender.MainDoc" >}}
82+
[Wireless Receiver Block]: {{< url path="Cortex.Reference.Blocks.Wireless.WirelessReceiver.WirelessReceiver.MainDoc" >}}
83+
[WirelessReceiverBlockReference]: {{< url path="Cortex.Reference.DataTypes.Wireless.WirelessReceiverBlockReference.MainDoc" >}}
84+
[WirelessReceiverBlockNotFoundException]: {{< url path="Cortex.Reference.Exceptions.Wireless.WirelessReceiverBlockNotFoundException.MainDoc" >}}
85+
[WirelessReceiverExceptionBlockNotFound]: {{< url path="Cortex.Reference.Exceptions.Wireless.WirelessReceiverBlockNotFoundException.BlockNotFound" >}}
86+
[WirelessReceiverExceptionPropertyEmpty]: {{< url path="Cortex.Reference.Exceptions.Wireless.WirelessReceiverBlockNotFoundException.PropertyEmpty" >}}
87+
[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}}
88+
[Advanced]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.AdvancedProperties.MainDoc" >}}

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: "Wireless"
3+
linkTitle: "Wireless"
4+
description: "Exceptions related to issues with wireless blocks"
5+
---

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

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
---
2+
title: "WirelessReceiverBlockNotFoundException"
3+
linkTitle: "WirelessReceiverBlockNotFoundException"
4+
description: "The exception thrown when a wireless receiver block could not be found."
5+
---
6+
7+
# {{% param title %}}
8+
9+
<p class="namespace">(Cortex.Exceptions.Wireless.WirelessReceiverBlockNotFoundException)</p>
10+
11+
## Description
12+
13+
The exception thrown when a [Wireless Receiver][Wireless Receiver Block] block could not be found.
14+
15+
There are multiple reasons that this exception can be thrown:
16+
17+
- [Wireless Receiver Block Not Found][WirelessReceiverExceptionBlockNotFound]
18+
- [Wireless Receiver Property Empty][WirelessReceiverExceptionPropertyEmpty]
19+
20+
## Reasons
21+
22+
### Wireless Receiver Block Not Found {#100}
23+
24+
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.
25+
26+
#### Message Format
27+
28+
```json
29+
"The 'Wireless Receiver Block' provided could not be found.
30+
Please click the HelpLink for more information on how to fix this."
31+
```
32+
33+
#### How to fix
34+
35+
Ensure the correct [Wireless Receiver][Wireless Receiver Block] block is selected.
36+
37+
### Wireless Receiver Property Empty {#101}
38+
39+
A [Category][] of `NotFound` and an [Error Code][] of `101` indicates that a [Wireless Receiver][Wireless Receiver Block] block has not been selected.
40+
41+
#### Message Format
42+
43+
```json
44+
"'Wireless Receiver Block' is empty; it must be provided a value.
45+
Please click the HelpLink for more information on how to fix this."
46+
```
47+
48+
#### How to fix
49+
50+
Ensure a [Wireless Receiver][Wireless Receiver Block] block is selected.
51+
52+
## Properties
53+
54+
### Exception Type
55+
56+
The type of the exception (i.e. `WirelessReceiverBlockNotFoundException`)
57+
58+
| | |
59+
|-----------|------------|
60+
| Data Type | [String][] |
61+
62+
### Message
63+
64+
The exception message, providing information about the exception that occurred.
65+
66+
| | |
67+
|-----------|------------|
68+
| Data Type | [String][] |
69+
70+
### Category
71+
72+
The category of the exception, which is used to categorise an exception if there are multiple reasons that the exception can occur.
73+
74+
For `WirelessReceiverBlockNotFoundException` there are the following categories:
75+
76+
- `NotFound`
77+
78+
| | |
79+
|-----------|------------|
80+
| Data Type | [String][] |
81+
82+
### Error Code
83+
84+
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.
85+
86+
For `WirelessReceiverBlockNotFoundException` there are the following error codes:
87+
88+
- [100][WirelessReceiverBlockNotFound] - indicates that the [Wireless Receiver][Wireless Receiver Block] block could not be found
89+
- [101][WirelessReceiverPropertyEmpty] - indicates that the [Wireless Receiver Block][Wireless Receiver Block Property] property was empty
90+
91+
| | |
92+
|-----------|---------------------------|
93+
| Data Type | [WirelessReceiverNotFoundErrorCode][WirelessReceiverNotFoundErrorCode] |
94+
95+
### Help Link
96+
97+
The URL for the relevant section of this exception's help page.
98+
99+
| | |
100+
|-----------|------------|
101+
| Data Type | [String][] |
102+
103+
## Remarks
104+
105+
### Known Limitations
106+
107+
None
108+
109+
## See Also
110+
111+
### Related Data Types
112+
113+
* [String][]
114+
* [WirelessReceiverNotFoundErrorCode][]
115+
116+
### Related Concepts
117+
118+
* [Exceptions][]
119+
120+
### Related Blocks
121+
122+
* [Wireless Sender Block][]
123+
124+
### External Documentation
125+
126+
None
127+
128+
[Category]: {{< ref "#category">}}
129+
[Error Code]: {{< ref "#error-code">}}
130+
[WirelessReceiverBlockNotFound]: {{< ref "#100">}}
131+
[WirelessReceiverPropertyEmpty]: {{< ref "#101">}}
132+
133+
[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}}
134+
135+
[Exceptions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.MainDoc" >}}
136+
137+
[Wireless Sender Block]: {{< url path="Cortex.Reference.Blocks.Wireless.WirelessSender.WirelessSender.MainDoc" >}}
138+
[Wireless Receiver Block]: {{< url path="Cortex.Reference.Blocks.Wireless.WirelessReceiver.WirelessReceiver.MainDoc" >}}
139+
[WirelessReceiverExceptionBlockNotFound]: {{< url path="Cortex.Reference.Exceptions.Wireless.WirelessReceiverBlockNotFoundException.BlockNotFound" >}}
140+
[WirelessReceiverExceptionPropertyEmpty]: {{< url path="Cortex.Reference.Exceptions.Wireless.WirelessReceiverBlockNotFoundException.PropertyEmpty" >}}
141+
[WirelessReceiverNotFoundErrorCode]: {{< url path="Cortex.Reference.DataTypes.Wireless.WirelessReceiverBlockNotFoundErrorCode.MainDoc" >}}
142+
[Wireless Receiver Block Property]: {{< url path="Cortex.Reference.Blocks.Wireless.WirelessSender.WirelessSender.WirelessReceiverProperty" >}}

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Wireless"
3+
linkTitle: "Wireless"
4+
description: "Data types used for working with Wireless blocks."
5+
weight: 1
6+
---

0 commit comments

Comments
 (0)