Skip to content

Commit

Permalink
Deploying to gh-pages from @ fc82492 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
vlasebian committed Jan 22, 2025
1 parent d7495f6 commit d145529
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
5 changes: 4 additions & 1 deletion integrations/payload-formatters/javascript/uplink/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@ <h1 class="title is-size-2">Uplink</h1>
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// {
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// &#34;bytes&#34;: [1, 2, 3], // FRMPayload (byte array)
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// &#34;fPort&#34;: 1
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// &#34;recvTime&#34;: &#34;Thu Jan 16 2025 17:29:37 GMT+0200 (Eastern European Standard Time)&#34; // receivedAt (Date object)
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// }
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="k">return</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">data</span><span class="o">:</span> <span class="p">{</span>
Expand Down Expand Up @@ -334,6 +335,7 @@ <h2 id="uplink-example-the-things-node">Uplink Example: The Things Node</h2>
</span></span><span class="line"><span class="cl"> <span class="mi">3</span><span class="o">:</span> <span class="s2">&#34;motion&#34;</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="mi">4</span><span class="o">:</span> <span class="s2">&#34;button&#34;</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">};</span>
</span></span><span class="line"><span class="cl"> <span class="nx">data</span><span class="p">.</span><span class="nx">recvTime</span> <span class="o">=</span> <span class="nx">input</span><span class="p">.</span><span class="nx">recvTime</span><span class="p">.</span><span class="nx">toString</span><span class="p">();</span>
</span></span><span class="line"><span class="cl"> <span class="nx">data</span><span class="p">.</span><span class="nx">event</span> <span class="o">=</span> <span class="nx">events</span><span class="p">[</span><span class="nx">input</span><span class="p">.</span><span class="nx">fPort</span><span class="p">];</span>
</span></span><span class="line"><span class="cl"> <span class="nx">data</span><span class="p">.</span><span class="nx">battery</span> <span class="o">=</span> <span class="p">(</span><span class="nx">input</span><span class="p">.</span><span class="nx">bytes</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">&lt;&lt;</span> <span class="mi">8</span><span class="p">)</span> <span class="o">+</span> <span class="nx">input</span><span class="p">.</span><span class="nx">bytes</span><span class="p">[</span><span class="mi">1</span><span class="p">];</span>
</span></span><span class="line"><span class="cl"> <span class="nx">data</span><span class="p">.</span><span class="nx">light</span> <span class="o">=</span> <span class="p">(</span><span class="nx">input</span><span class="p">.</span><span class="nx">bytes</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="o">&lt;&lt;</span> <span class="mi">8</span><span class="p">)</span> <span class="o">+</span> <span class="nx">input</span><span class="p">.</span><span class="nx">bytes</span><span class="p">[</span><span class="mi">3</span><span class="p">];</span>
Expand Down Expand Up @@ -361,7 +363,7 @@ <h2 id="uplink-example-the-things-node">Uplink Example: The Things Node</h2>
</span></span><span class="line"><span class="cl"> <span class="p">};</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre></div><p>For example, the end device observed an event and performed some measurements. The end device transmitted the following binary payload: <code>0C B2 04 80 F7 AE</code> (hex encoded) on FPort 4. The Base64 equivalent of that binary payload is <code>DLIEgPeu</code> and the JavaScript byte array is <code>[ 12, 178, 4, 128, 247, 174 ]</code>. This is all the same, just a different representation.</p>
<p>The uplink decoder gets the JavaScript byte array of the binary payload and FPort as input. The Things Stack sets <code>frm_payload</code> to the Base64 representation of the binary payload, and <code>decoded_payload</code> to the output <code>data</code> of the uplink decoder. If there are warnings, they are set in <code>decoded_payload_warnings</code>.</p>
<p>The uplink decoder gets the JavaScript byte array of the binary payload, the FPort and the time of receipt (<code>recvTime</code>) as input. The Things Stack sets <code>frm_payload</code> to the Base64 representation of the binary payload, and <code>decoded_payload</code> to the output <code>data</code> of the uplink decoder. If there are warnings, they are set in <code>decoded_payload_warnings</code>.</p>
<p>The <code>data.uplink_message</code> object of the <code>as.up.data.forward</code> event will contain:</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">&#34;uplink_message&#34;</span><span class="p">:</span> <span class="p">{</span>
Expand All @@ -371,6 +373,7 @@ <h2 id="uplink-example-the-things-node">Uplink Example: The Things Node</h2>
</span></span><span class="line"><span class="cl"> <span class="nt">&#34;battery&#34;</span><span class="p">:</span> <span class="mi">3250</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">&#34;event&#34;</span><span class="p">:</span> <span class="s2">&#34;setup&#34;</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">&#34;light&#34;</span><span class="p">:</span> <span class="mi">1152</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">&#34;recvTime&#34;</span><span class="p">:</span> <span class="s2">&#34;Tue Jan 21 2025 17:56:54 GMT+0100 (CET)&#34;</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">&#34;temperature&#34;</span><span class="p">:</span> <span class="mf">-21.3</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nt">&#34;decoded_payload_warnings&#34;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&#34;it&#39;s cold&#34;</span><span class="p">],</span>
Expand Down
2 changes: 1 addition & 1 deletion sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@
<lastmod>2025-01-20T14:54:42+01:00</lastmod>
</url><url>
<loc>https://www.thethingsindustries.com/docs/integrations/payload-formatters/javascript/uplink/</loc>
<lastmod>2024-03-04T15:43:05+01:00</lastmod>
<lastmod>2025-01-22T14:04:22+02:00</lastmod>
</url><url>
<loc>https://www.thethingsindustries.com/docs/integrations/webhooks/webhook-templates/</loc>
<lastmod>2020-10-21T08:39:42+02:00</lastmod>
Expand Down

0 comments on commit d145529

Please sign in to comment.