Skip to content

Commit

Permalink
Deploying to gh-pages from @ 1b39955 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
vlasebian committed Oct 9, 2024
1 parent a7e1277 commit f768346
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 14 deletions.
20 changes: 10 additions & 10 deletions devices/configuring-devices/relay-settings/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -198,12 +198,12 @@ <h3 class="title has-text-dark mb-1">Command-line interface only</h3>
<h2 id="retroactivity">Retroactivity</h2>
<p>In contrast to <a href="https://www.thethingsindustries.com/docs/devices/configuring-devices/mac-settings/">MAC settings</a>, the relay configuration commands will automatically apply changes to both the current, pending and future sessions of the end devices.</p>
<h2 id="examples">Examples</h2>
<h3 id="enabling-the-serving-mode-hahahugoshortcode63s3hbhb">Enabling the Serving Mode <span class="tag is-light">New in 3.29.0</span>
<h3 id="enabling-the-serving-mode-hahahugoshortcode60s3hbhb">Enabling the Serving Mode <span class="tag is-light">New in 3.29.0</span>

</h3>
<p>In order to enable the <a href="https://www.thethingsindustries.com/docs/devices/concepts/relay/#relay-mode">serving mode</a> of an end device, use the <code>create</code> command and the <code>--mode.serving</code> parameter.</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">ttn-lw-cli relays create &lt;app-id&gt; &lt;device-id&gt; --mode.serving
</span></span></code></pre></div><h3 id="enabling-the-served-mode-hahahugoshortcode63s5hbhb">Enabling the Served Mode <span class="tag is-light">New in 3.29.0</span>
</span></span></code></pre></div><h3 id="enabling-the-served-mode-hahahugoshortcode60s5hbhb">Enabling the Served Mode <span class="tag is-light">New in 3.29.0</span>

</h3>
<p>In order to enable the <a href="https://www.thethingsindustries.com/docs/devices/concepts/relay/#relay-mode">served mode</a> of an end device, use the <code>create</code> command and the <code>--mode.served</code> flag.</p>
Expand All @@ -219,24 +219,24 @@ <h5 class="title is-family-sans-serif has-text-dark mb-1">Note:</h5>
<li>A device may attempt to use the serving end device only after it has not received a downlink message recently. This mode is called <em>dynamic</em>, and can be used using the <code>--mode.served.mode.dynamic</code> flag.</li>
<li>A device may have its own algorithm to choose when to use the serving end device. This mode is called <em>end device controlled</em>, and can be used using the <code>--mode.served.mode.end-device-controlled</code> flag.</li>
</ol>
<h3 id="retrieving-the-settings-hahahugoshortcode63s8hbhb">Retrieving the Settings <span class="tag is-light">New in 3.29.0</span>
<h3 id="retrieving-the-settings-hahahugoshortcode60s8hbhb">Retrieving the Settings <span class="tag is-light">New in 3.29.0</span>

</h3>
<p>In order to retrieve the settings of a serving end device, use the <code>get</code> command.</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">ttn-lw-cli relays get &lt;app-id&gt; &lt;device-id&gt; --mode.serving
</span></span></code></pre></div><p>The <code>--mode.served</code> may be used to retrieve the settings of a served end device.</p>
<h3 id="updating-the-settings-hahahugoshortcode63s9hbhb">Updating the Settings <span class="tag is-light">New in 3.29.0</span>
<h3 id="updating-the-settings-hahahugoshortcode60s9hbhb">Updating the Settings <span class="tag is-light">New in 3.29.0</span>

</h3>
<p>In order to update the settings of an end device, use the <code>set</code> command.</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">ttn-lw-cli relays <span class="nb">set</span> &lt;app-id&gt; &lt;device-id&gt; --mode.serving.cad-periodicity <span class="m">1</span>
</span></span></code></pre></div><p>You can see the possible parameters which can be updated using the <code>--help</code> flag.</p>
<h3 id="removing-the-settings-hahahugoshortcode63s10hbhb">Removing the Settings <span class="tag is-light">New in 3.29.0</span>
<h3 id="removing-the-settings-hahahugoshortcode60s10hbhb">Removing the Settings <span class="tag is-light">New in 3.29.0</span>

</h3>
<p>In order to delete all of the relay settings of an end device, use the <code>delete</code> command.</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">ttn-lw-cli relays delete &lt;app-id&gt; &lt;device-id&gt;
</span></span></code></pre></div><h3 id="creating-an-uplink-forwarding-rule-hahahugoshortcode63s11hbhb">Creating an Uplink Forwarding Rule <span class="tag is-light">New in 3.29.0</span>
</span></span></code></pre></div><h3 id="creating-an-uplink-forwarding-rule-hahahugoshortcode60s11hbhb">Creating an Uplink Forwarding Rule <span class="tag is-light">New in 3.29.0</span>

</h3>
<p>In order to create an uplink forwarding rule on a serving end device, for a served end device, use the <code>uplink-forwarding-rules create</code> command.</p>
Expand All @@ -251,25 +251,25 @@ <h5 class="title is-family-sans-serif has-text-dark mb-1">Note:</h5>
</div>
</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">ttn-lw-cli relays uplink-forwarding-rules create &lt;app-id&gt; &lt;device-id&gt; &lt;rule-id&gt; --device-id &lt;served-device-id&gt;
</span></span></code></pre></div><h3 id="retrieving-all-uplink-forwarding-rules-hahahugoshortcode63s14hbhb">Retrieving All Uplink Forwarding Rules <span class="tag is-light">New in 3.29.0</span>
</span></span></code></pre></div><h3 id="retrieving-all-uplink-forwarding-rules-hahahugoshortcode60s14hbhb">Retrieving All Uplink Forwarding Rules <span class="tag is-light">New in 3.29.0</span>

</h3>
<p>In order to retrieve all of the uplink forwarding rules of a serving end device, use the <code>uplink-forwarding-rules list</code> command.</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">ttn-lw-cli relays uplink-forwarding-rules list &lt;app-id&gt; &lt;device-id&gt; --device-id
</span></span></code></pre></div><p>Like other <code>list</code>-like commands in The Things Stack, the fields which are returned have to be specified in the command flags. Use the <code>--help</code> flags to see which other fields can be retrieved.</p>
<h3 id="retrieving-individual-uplink-forwarding-rules-hahahugoshortcode63s16hbhb">Retrieving Individual Uplink Forwarding Rules <span class="tag is-light">New in 3.29.0</span>
<h3 id="retrieving-individual-uplink-forwarding-rules-hahahugoshortcode60s16hbhb">Retrieving Individual Uplink Forwarding Rules <span class="tag is-light">New in 3.29.0</span>

</h3>
<p>In order to retrieve an individual uplink forwarding rule of a serving end device, use the <code>uplink-forwarding-rules get</code> command.</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">ttn-lw-cli relays uplink-forwarding-rules get &lt;app-id&gt; &lt;device-id&gt; &lt;rule-id&gt;
</span></span></code></pre></div><p>Like other <code>get</code>-like commands in The Things Stack, the fields which are returned have to be specified in the command flags. Use the <code>--help</code> flags to see which other fields can be retrieved.</p>
<h3 id="updating-uplink-forwarding-rules-hahahugoshortcode63s18hbhb">Updating Uplink Forwarding Rules <span class="tag is-light">New in 3.29.0</span>
<h3 id="updating-uplink-forwarding-rules-hahahugoshortcode60s18hbhb">Updating Uplink Forwarding Rules <span class="tag is-light">New in 3.29.0</span>

</h3>
<p>In order to update an uplink forwarding rule of a serving end device, use the <code>uplink-forwarding-rules set</code> command.</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">ttn-lw-cli relays uplink-forwarding-rules <span class="nb">set</span> &lt;app-id&gt; &lt;device-id&gt; &lt;rule-id&gt; --device-id &lt;serving-device-id&gt;
</span></span></code></pre></div><p>You can see the possible parameters which can be updated using the <code>--help</code> flag.</p>
<h3 id="deleting-uplink-forwarding-rules-hahahugoshortcode63s19hbhb">Deleting Uplink Forwarding Rules <span class="tag is-light">New in 3.29.0</span>
<h3 id="deleting-uplink-forwarding-rules-hahahugoshortcode60s19hbhb">Deleting Uplink Forwarding Rules <span class="tag is-light">New in 3.29.0</span>

</h3>
<p>In order to delete an uplink forwarding rule of a serving end device, use the <code>uplink-forwarding-rules delete</code> command.</p>
Expand Down
2 changes: 1 addition & 1 deletion sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@
<lastmod>2023-12-21T13:26:05+01:00</lastmod>
</url><url>
<loc>https://www.thethingsindustries.com/docs/the-things-stack/host/aws/ami/deployment-guide/</loc>
<lastmod>2023-04-19T08:14:44+02:00</lastmod>
<lastmod>2024-10-09T13:19:12+02:00</lastmod>
</url><url>
<loc>https://www.thethingsindustries.com/docs/devices/configuring-devices/device-location/</loc>
<lastmod>2024-09-02T11:11:58+02:00</lastmod>
Expand Down
12 changes: 9 additions & 3 deletions the-things-stack/host/aws/ami/deployment-guide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,7 @@ <h3 id="prerequisites">Prerequisites</h3>
<li>A LoRaWAN® compliant Gateway</li>
<li>A LoRaWAN compliant End Device</li>
<li>Access to a name server for DNS mapping</li>
<li>(Optional) An AWS Secret containing TLS certificate data, if a custom TLS certificate is needed</li>
</ol>
<h2 id="deployment-using-aws-cloud-formation">Deployment using AWS Cloud Formation</h2>
<h3 id="step-1-prepare-the-deployment">Step 1: Prepare the Deployment</h3>
Expand Down Expand Up @@ -376,20 +377,25 @@ <h4 id="security-configuration">Security Configuration</h4>
<td style="text-align: left">-</td>
</tr>
<tr>
<td style="text-align: left">TLS Certificate</td>
<td style="text-align: left">TLS Certificate*</td>
<td style="text-align: left">TLS certificate to use. If left empty, TLS certificates from Let&rsquo;s Encrypt will automatically be requested.</td>
<td style="text-align: left">-</td>
</tr>
<tr>
<td style="text-align: left">TLS Certificate Key</td>
<td style="text-align: left">TLS Certificate Key*</td>
<td style="text-align: left">TLS certificate key to use. If left empty, TLS certificates from Let&rsquo;s Encrypt will automatically be requested.</td>
<td style="text-align: left">-</td>
</tr>
<tr>
<td style="text-align: left">TLS Certificate CA</td>
<td style="text-align: left">TLS Certificate CA*</td>
<td style="text-align: left">TLS certificate CA to use. If left empty, TLS certificates from Let&rsquo;s Encrypt will automatically be requested.</td>
<td style="text-align: left">-</td>
</tr>
<tr>
<td style="text-align: left">ARN of an AWS Secret containing the TLS certificate data*</td>
<td style="text-align: left">TLS certificate data specified as an AWS secret. If this secret is specified, TLSCertificate, TLSCertificateCA and TLSCertificateKey values will be ignored. The AWS secret must have 3 key/value pairs with the key names: cert, key, ca.</td>
<td style="text-align: left">-</td>
</tr>
</tbody>
</table>
<blockquote>
Expand Down

0 comments on commit f768346

Please sign in to comment.