Skip to content

Commit 3097b37

Browse files
simoneromgitbook-bot
authored andcommitted
GITBOOK-293: Add API Key documentation
1 parent 8fca3b1 commit 3097b37

35 files changed

+209
-84
lines changed
Loading
436 KB
Loading
-219 KB
Loading

.gitbook/assets/image (1) (1) (1).png

-210 KB
Loading

.gitbook/assets/image (1) (1).png

1.3 MB
Loading

.gitbook/assets/image (1).png

62.1 KB
Loading

.gitbook/assets/image (45).png

399 KB
Loading

.gitbook/assets/image.png

-1.05 MB
Loading

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Any community member interested in operating a W3bstream node could provision a
7979
{% hint style="success" %}
8080
### What's next?
8181

82-
Checkout the [**Get Started**](client-device-sdks/introduction.md) section to learn how to run a W3bstream node.
82+
Checkout the [**Get Started**](sending-data-to-w3bstream/introduction-1/) section to learn how to run a W3bstream node.
8383

8484
Learn about the fundamentals of [**programming** ](get-started/basic-concepts/)a W3bstream node.
8585
{% endhint %}

SUMMARY.md

+21-17
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
* [Event Triggers](get-started/basic-concepts/events.md)
1616
* [Event Routing Strategies](get-started/basic-concepts/event-strategies.md)
1717
* [Device Accounts](get-started/basic-concepts/publishers.md)
18-
* [Message Protocol](get-started/basic-concepts/message-api.md)
1918
* [Access W3bstream](get-started/access-w3bstream.md)
2019
* [Deploy "Hello World"](get-started/deploying-an-applet.md)
2120
* [W3bstream Studio](get-started/w3bstream-studio/README.md)
@@ -27,6 +26,7 @@
2726
* [Sending Test Data](get-started/w3bstream-studio/triggering-events/testing-events.md)
2827
* [Routing Events](get-started/w3bstream-studio/creating-strategies.md)
2928
* [Create Database Tables](get-started/w3bstream-studio/create-database-tables.md)
29+
* [Create API Keys](get-started/w3bstream-studio/create-api-keys.md)
3030

3131
## 👨💻 Applets Development
3232

@@ -48,6 +48,26 @@
4848
* [Token Proofs](applets-development/advanced-concepts/token-proofs.md)
4949
* [Trusted IoT Data](applets-development/advanced-concepts/trusted-iot-data.md)
5050

51+
## ⚙ Sending Data to W3bstream
52+
53+
* [Introduction](sending-data-to-w3bstream/introduction.md)
54+
* [W3bstream Data API](sending-data-to-w3bstream/w3bstream-data-api/README.md)
55+
* [HTTP API](sending-data-to-w3bstream/w3bstream-data-api/http-api.md)
56+
* [MQTT Broker](sending-data-to-w3bstream/w3bstream-data-api/mqtt-broker.md)
57+
* [PC Client SDKs](sending-data-to-w3bstream/pc-client-sdks/README.md)
58+
* [Node JS](sending-data-to-w3bstream/pc-client-sdks/node-js.md)
59+
* [Python](sending-data-to-w3bstream/pc-client-sdks/python.md)
60+
* [Go lang](sending-data-to-w3bstream/pc-client-sdks/go-lang.md)
61+
* [IoT Client SDKs](sending-data-to-w3bstream/introduction-1/README.md)
62+
* [Technical goals](sending-data-to-w3bstream/introduction-1/technical-goals.md)
63+
* [Business Goals](sending-data-to-w3bstream/introduction-1/business-goals.md)
64+
* [Technical Framework](sending-data-to-w3bstream/introduction-1/technical-framework.md)
65+
* [Linux Embedded](sending-data-to-w3bstream/introduction-1/embedded-sdks.md)
66+
* [ESP32](sending-data-to-w3bstream/introduction-1/esp32.md)
67+
* [Arduino](sending-data-to-w3bstream/introduction-1/arduino.md)
68+
* [Pebble Tracker](sending-data-to-w3bstream/introduction-1/pebble-tracker.md)
69+
* [Mobile Client SDKs](sending-data-to-w3bstream/mobile-client-sdks.md)
70+
5171
## 📊 Trusted Metrics Service
5272

5373
* [About Trusted Metrics](trusted-metrics-service/about-trusted-metrics.md)
@@ -61,22 +81,6 @@
6181
* [Integrating the Device Map](trusted-metrics-service/depinscan/integrating-the-device-map.md)
6282
* [Getting Verified](trusted-metrics-service/depinscan/getting-verified.md)
6383

64-
## ⚙ Client SDKs
65-
66-
* [Mobile SDKs](client-device-sdks/supported-platforms/mobile-devices.md)
67-
* [PC Client SDKs](client-sdks/pc-client-sdks/README.md)
68-
* [Node JS](client-sdks/pc-client-sdks/node-js.md)
69-
* [Python](client-sdks/pc-client-sdks/python.md)
70-
* [Go lang](client-sdks/pc-client-sdks/go-lang.md)
71-
* [IoT Client SDKs](client-device-sdks/introduction.md)
72-
* [Technical goals](client-device-sdks/embedded-sdks/technical-goals.md)
73-
* [Business Goals](client-device-sdks/embedded-sdks/business-goals.md)
74-
* [Technical Framework](client-device-sdks/embedded-sdks/technical-framework.md)
75-
* [Linux Embedded](client-device-sdks/supported-platforms/embedded-sdks.md)
76-
* [ESP32](client-device-sdks/supported-platforms/esp32.md)
77-
* [Arduino](client-device-sdks/supported-platforms/arduino.md)
78-
* [Pebble Tracker](client-device-sdks/supported-platforms/pebble-tracker.md)
79-
8084
## 📚 Additional Resources
8185

8286
* [Landing Page](https://w3bstream.com/)
+9-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
11
# Configuring Devices
22

3-
Before your project can receive any data messages from a device, you will need to add a new device account in the _Devices_ tab of the Project Editor. See the quick video below to learn how to create a new Device Account:
3+
Before your project can receive any data messages from a device, you will need to add a new device account in the _Devices_ tab of the Project Editor. 
4+
5+
## Creating Devices using W3bstream Studio
6+
7+
See the quick video below to learn how to create a new Device Account:
48

59
{% content-ref url="configuring-devices.md" %}
610
[configuring-devices.md](configuring-devices.md)
711
{% endcontent-ref %}
812

913
Any client device intending to send data to your W3bstream project must include a valid authentication token within the message. 
1014

11-
{% hint style="info" %}
12-
Depending on your use case, you can use one token for each device or for groups of devices.
15+
## Creating devices using the Publisher API
16+
17+
{% hint style="warning" %}
18+
This section a work in progress and will be available soon.
1319
{% endhint %}

applets-development/sending-messages-to-w3bstream.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ Here's an overview of how it works.
66

77
## Using W3bstream Client SDKs
88

9-
In the previous section [message-api.md](../get-started/basic-concepts/message-api.md "mention") we discussed the messaging format specified by the W3bstream API. Each W3bstream message contains a payload string field, which is intended to hold the actual data sent by a smart device to our project and to be processed by a handler.
9+
In the previous section [http-api.md](../sending-data-to-w3bstream/w3bstream-data-api/http-api.md "mention") we discussed the messaging format specified by the W3bstream API. Each W3bstream message contains a payload string field, which is intended to hold the actual data sent by a smart device to our project and to be processed by a handler.
1010

1111
To simplify the process of sending data to your W3bstream project, we recommend utilizing a W3bstream Client SDK tailored for your specific device. By doing so, you won't need to concern yourself with the intricacies of the W3bstream messaging protocol. Instead, you can focus on providing the relevant data for your application, including the target project name, event type, and device authentication token.
1212

1313
If you're unsure which W3bstream Client SDK is suitable for your device, please refer to our documentation for additional guidance and information.
1414

15-
{% content-ref url="../client-device-sdks/introduction.md" %}
16-
[introduction.md](../client-device-sdks/introduction.md)
15+
{% content-ref url="../sending-data-to-w3bstream/introduction-1/" %}
16+
[introduction-1](../sending-data-to-w3bstream/introduction-1/)
1717
{% endcontent-ref %}
1818

1919
## Example message

client-device-sdks/introduction.md

-7
This file was deleted.

client-device-sdks/supported-platforms/arduino.md

-6
This file was deleted.

get-started/basic-concepts/message-api.md

-41
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Create API Keys
2+

introduction/roadmap.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The development of W3bstream will span until Q2 2024. During this time, the “_
5656
{% hint style="success" %}
5757
### What's next?
5858

59-
Checkout the [**Get Started**](../client-device-sdks/introduction.md) section to learn how to run a W3bstream node.
59+
Checkout the [**Get Started**](../sending-data-to-w3bstream/introduction-1/) section to learn how to run a W3bstream node.
6060

6161
Learn about the fundamentals of [**programming** ](../get-started/basic-concepts/)a W3bstream node.
6262
{% endhint %}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# IoT Client SDKs
2+
3+
W3bstream aims to accommodate a wide range of IoT devices with different hardware components and capabilities, from legacy Web2-based products, over community-driven development boards, to emerging Web3-oriented devices and mobile phones.
4+
5+
By using the W3bstream Client SDK, you can ensure that your data is sent securely and reliably to your W3bstream project. The SDK takes care of authentication, encryption, and other important details, so you can focus on building your project.
6+
7+
<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Mobile</strong> <strong>Client SDK</strong></td><td>Send data to W3bstream from mobile devices.</td><td></td><td><a href="../../.gitbook/assets/Screen Shot 2023-05-23 at 8.56.44 PM.png">Screen Shot 2023-05-23 at 8.56.44 PM.png</a></td><td><a href="../mobile-client-sdks.md">mobile-client-sdks.md</a></td></tr><tr><td><strong>Pebble Client SDK</strong></td><td>Send verifiable data to W3bstream from your Pebble Tracker.</td><td></td><td><a href="../../.gitbook/assets/Screen Shot 2023-05-23 at 11.11.45 PM.png">Screen Shot 2023-05-23 at 11.11.45 PM.png</a></td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><strong>Linux Embedded Client SDKs</strong></td><td>Send data to W3bstream from popular Linux-based boards.</td><td></td><td><a href="../../.gitbook/assets/embedded-header.jpg">embedded-header.jpg</a></td><td><a href="embedded-sdks.md">embedded-sdks.md</a></td></tr><tr><td><strong>ESP32 Client</strong> <strong>SDK</strong></td><td>Send data to W3bstream from an ESP32 Board.</td><td></td><td><a href="../../.gitbook/assets/Screen Shot 2023-05-23 at 10.54.45 PM.png">Screen Shot 2023-05-23 at 10.54.45 PM.png</a></td><td><a href="esp32.md">esp32.md</a></td></tr><tr><td><strong>Arduino Client</strong> <strong>SDK</strong></td><td>Send data to W3bstream from an Arduino Board.</td><td>🔜 </td><td><a href="../../.gitbook/assets/Screen Shot 2023-05-23 at 11.09.04 PM.png">Screen Shot 2023-05-23 at 11.09.04 PM.png</a></td><td><a href="arduino.md">arduino.md</a></td></tr></tbody></table>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Arduino
2+
3+
The W3bstream IoT SDK is available for Arduino-based boards.
4+
5+
For installation, supported devices and usage guides, please check out the GitHub repository below:
6+
7+
{% embed url="https://github.com/machinefi/w3bstream-client-arduino-ce" %}

client-device-sdks/supported-platforms/embedded-sdks.md renamed to sending-data-to-w3bstream/introduction-1/embedded-sdks.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# Linux Embedded
22

3-
Set up the build environment
3+
{% hint style="info" %}
4+
**Notice**: The Linux Embedded Client SDK does not include a W3bstream Client object. To create API calls, you will need to utilize the HTTP/MQTT clients directly. Detailed examples can be located within the SDK repository for your reference.
5+
6+
[Go to the examples folder...](https://github.com/machinefi/web3-iot-sdk/tree/main/examples)
7+
{% endhint %}
8+
9+
## Set up the build environment
410

511
Iotex SDK officially supports a limited set of build environments and setups. In this context, official support means that the environments listed below are actively used by team members and active developers, hence users should be able to recreate the same configurations by following the instructions described below.\
612
In case of problems, the Iotex SDK team provides support only for these environments, but building in other environments can still be possible.
@@ -29,15 +35,15 @@ Install the following dependencies:
2935
* MinGW32: [https://sourceforge.net/projects/mingw-w64/files/](https://sourceforge.net/projects/mingw-w64/files/)
3036
* Python3 and pip (included by default): [https://www.python.org/downloads/](https://www.python.org/downloads/)
3137

32-
### Get the source code
38+
## Get the source code
3339

3440
Run the following command to clone the repository:
3541

3642
```bash
3743
git clone https://github.com/machinefi/web3-iot-sdk.git
3844
```
3945

40-
### Build
46+
## Build
4147

4248
The build process is managed by CMake. The build can be customized by passing CMake options.\
4349
For a full list of CMake options see the main [CMakeLists.tx](https://github.com/machinefi/w3bstream-iot-sdk/blob/main/CMakeLists.txt). Below is a description of the most common ones:
@@ -92,6 +98,6 @@ TOTAL SKIPPED : 2
9298
******************************************
9399
```
94100

95-
### Examples
101+
## Examples
96102

97103
Examples to demonstrate the usage of the SDK can be found in the [examples](https://github.com/machinefi/web3-iot-sdk/tree/main/examples) of the SDK. Each example contains a README file with usage instructions.

0 commit comments

Comments
 (0)