From b4ba169dee7d1167333ba4f821175f3873ac9432 Mon Sep 17 00:00:00 2001 From: Teodor Date: Thu, 20 Jun 2024 21:31:13 +0200 Subject: [PATCH 1/6] draft script for new videos 11 and 12 --- .../new_video_11_12_script_temp.md | 72 +++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 Tutorials/whatiswot/Project_Details/new_video_11_12_script_temp.md diff --git a/Tutorials/whatiswot/Project_Details/new_video_11_12_script_temp.md b/Tutorials/whatiswot/Project_Details/new_video_11_12_script_temp.md new file mode 100644 index 00000000..69e20adb --- /dev/null +++ b/Tutorials/whatiswot/Project_Details/new_video_11_12_script_temp.md @@ -0,0 +1,72 @@ +# Video 11: Application and architecture patterns in Smart Homes and Smart Cities + +- In this two-part tutorial, we will introduce the W3C Web of Things by exploring its application domains and common architecture patterns. In this video our focus will be Smart Homes and Smart Cities. + +## Brief Introduction: + +- The WoT aims to preserve and complement existing IoT standards and solutions by providing a standardized approach for connecting and integrating smart devices, services, and applications into the Web. + +## Smart Homes + +### Introduce smart homes: +- In smart homes, the ability to connect and manage multiple assets remotely over the network is highly beneficial. + +- This helps within various activities within the home, such as controlling lights, adjusting room temperature, managing home appliances, and enhancing security using smartphones. These capabilities enable optimization of energy and resource consumption. + +**Graphic:** `House with many WoT-powered devices, showcasing Thing Description of the house` + +### Architecture patterns: + +1. **Remote Controllers:** + +- A common pattern involves using a remote controller to interact with devices via the home network. +- Devices act as servers, responding to commands from client controllers (e.g., smartphones) for actions such as adjusting settings or activating sensors. + +**Graphic:** `TD of the house transitions into a phone interface (controller) demonstrating interactions with different devices` + +2. **Gateways:** + +- Gateways connect home networks to the internet, enabling remote management and monitoring. +- They facilitate communication between local devices and external controllers, enhancing accessibility and control. + +**Graphic:** `Old Video 11 Cloud Gateway Animation` + +## Smart cities + +### Introduce smart cities: + +- Similar to smart homes, monitoring of smart cities is possible. In this case, end users are citizens, municipalities, and government agencies. + +- In smart cities, bridges, dams, and canals can be monitored for material conditions or deterioration for maintenance repair work to prevent significant damage. Parking slots and street lights can be monitored for crowd management and optimized usage too. + +# Video 12: Application and architecture patterns in Industrial and Agriculture Systems + +## Brief introduction + +- Industrial applications of WoT involve more complex use cases compared to smart homes. + +## Industrial systems + +### Introduce industrial systems: + +- Industrial applications may resemble smart home applications but have broad requirements for instance, advanced monitoring of the connected manufacturing equipment as well as the manufactured products and predictions of any possible machine failures. + +- Mention different protocols in factories and show TDs + + +## Agriculture systems + +### Introduce agriculture systems: + +- Another domain-specific application is in agriculture systems. + +- With WoT, soil conditions can be monitored and optimal plans for watering and fertilizing can be created. Depending on the need, agricultural devices can be controled remotely. Thus the quality and quantity of the harvest can be increased. + +### Architecture Patterns: + +1. **Cross-domain Collaboration** + +- In cross-domain collaborations, each system involves other systems in other domains. For example, Smart Factory with Smart City, Smart City with Smart Home. In those models, you can exchange information directly with each other in a peer-to-peer manner or indirectly via some collaboration platform. + + + From 041f3781760639592e41a6884a0821488715305a Mon Sep 17 00:00:00 2001 From: Teodor Date: Thu, 26 Sep 2024 21:00:37 +0200 Subject: [PATCH 2/6] edit script and storyline --- .../new_video_11_12_script_temp.md | 18 ++++++++++++++---- .../new_video_11_storyline_temp.md | 10 ++++++++++ .../new_video_12_storyline_temp.md | 6 ++++++ 3 files changed, 30 insertions(+), 4 deletions(-) create mode 100644 Tutorials/whatiswot/Project_Details/new_video_11_storyline_temp.md create mode 100644 Tutorials/whatiswot/Project_Details/new_video_12_storyline_temp.md diff --git a/Tutorials/whatiswot/Project_Details/new_video_11_12_script_temp.md b/Tutorials/whatiswot/Project_Details/new_video_11_12_script_temp.md index 69e20adb..a63914e5 100644 --- a/Tutorials/whatiswot/Project_Details/new_video_11_12_script_temp.md +++ b/Tutorials/whatiswot/Project_Details/new_video_11_12_script_temp.md @@ -11,21 +11,25 @@ ### Introduce smart homes: - In smart homes, the ability to connect and manage multiple assets remotely over the network is highly beneficial. +- The interesting part about smart homes isn’t tied to a specific solution you buy, but rather in how WoT enables flexibility. Manufacturers can provide Thing Descriptions (TDs) for their devices, which lets anyone build and customize their own systems. By following these open standards, devices can communicate with each other across brands, allowing for seamless integration. This approach ensures that devices remain adaptable and private, and don’t become obsolete, as they can continuously support new use cases and technologies. + - This helps within various activities within the home, such as controlling lights, adjusting room temperature, managing home appliances, and enhancing security using smartphones. These capabilities enable optimization of energy and resource consumption. **Graphic:** `House with many WoT-powered devices, showcasing Thing Description of the house` ### Architecture patterns: -1. **Remote Controllers:** +1. **Controllers:** + +- A common pattern involves using a controller, both locally and remotely, to interact with devices via the home network by consuming the Thing Description. -- A common pattern involves using a remote controller to interact with devices via the home network. -- Devices act as servers, responding to commands from client controllers (e.g., smartphones) for actions such as adjusting settings or activating sensors. +- Devices are represented by TDs and act as servers, responding to commands from client controllers (e.g., smartphones) for actions such as adjusting settings or activating sensors. **Graphic:** `TD of the house transitions into a phone interface (controller) demonstrating interactions with different devices` 2. **Gateways:** +- Consumer can control it both locally or fully remotely. - Gateways connect home networks to the internet, enabling remote management and monitoring. - They facilitate communication between local devices and external controllers, enhancing accessibility and control. @@ -35,16 +39,22 @@ ### Introduce smart cities: -- Similar to smart homes, monitoring of smart cities is possible. In this case, end users are citizens, municipalities, and government agencies. +- Similar to smart homes, monitoring of smart cities is possible. In this case, end users are different - from citizens to municipalities and government agencies. + +- Smart cities need to cover multiple domains like water management / air quality monitoring and etc. (Like a website selling cars/pumps/breaks (multiple things in one place)). Since WoT is open-source, it is reliable to be used by governments. - In smart cities, bridges, dams, and canals can be monitored for material conditions or deterioration for maintenance repair work to prevent significant damage. Parking slots and street lights can be monitored for crowd management and optimized usage too. +- Different managers who manage different Things - multiownership. Show TDs for every Thing. Since it’s so big there’s usually a mix of architectures. + # Video 12: Application and architecture patterns in Industrial and Agriculture Systems ## Brief introduction - Industrial applications of WoT involve more complex use cases compared to smart homes. +- In industrial systems, devices from different manufacturers need to work together for a single use case. WoT supports this by accommodating various industry protocols, including legacy ones, ensuring seamless integration. The use of Thing Descriptions (TDs) allows devices to self-describe their capabilities, reducing the engineering effort needed to make them compatible. + ## Industrial systems ### Introduce industrial systems: diff --git a/Tutorials/whatiswot/Project_Details/new_video_11_storyline_temp.md b/Tutorials/whatiswot/Project_Details/new_video_11_storyline_temp.md new file mode 100644 index 00000000..7320b0dd --- /dev/null +++ b/Tutorials/whatiswot/Project_Details/new_video_11_storyline_temp.md @@ -0,0 +1,10 @@ +Video 11: Application and architecture patterns in Smart Homes and Smart Cities + +- Brief Introduction +- Smart Homes +- Remote Controllers +- Gateways +- Smart Cities + + + diff --git a/Tutorials/whatiswot/Project_Details/new_video_12_storyline_temp.md b/Tutorials/whatiswot/Project_Details/new_video_12_storyline_temp.md new file mode 100644 index 00000000..e0469be3 --- /dev/null +++ b/Tutorials/whatiswot/Project_Details/new_video_12_storyline_temp.md @@ -0,0 +1,6 @@ +Video 12: Application and architecture patterns in Industrial and Agriculture Systems + +- Brief Introduction +- Industrial Systems +- Agriculture Systems +- Cross-domain Collaboration From 2bda6089a964961c56e61a1dceeb7617bc0ce266 Mon Sep 17 00:00:00 2001 From: Ege Korkan Date: Fri, 27 Sep 2024 10:38:18 +0200 Subject: [PATCH 3/6] reorganize scripts and readmes --- .../whatiswot/10-Building_Blocks/README.md | 119 ++++++++++++++++++ .../README.md} | 65 +++------- .../README.md | 30 +++++ .../new_video_11_storyline_temp.md | 10 -- .../new_video_12_storyline_temp.md | 6 - 5 files changed, 169 insertions(+), 61 deletions(-) create mode 100644 Tutorials/whatiswot/10-Building_Blocks/README.md rename Tutorials/whatiswot/{Project_Details/new_video_11_12_script_temp.md => 11-Applications in Smart Homes and Smart Cities/README.md} (51%) create mode 100644 Tutorials/whatiswot/12-Applications in Industrial and Agriculture Systems/README.md delete mode 100644 Tutorials/whatiswot/Project_Details/new_video_11_storyline_temp.md delete mode 100644 Tutorials/whatiswot/Project_Details/new_video_12_storyline_temp.md diff --git a/Tutorials/whatiswot/10-Building_Blocks/README.md b/Tutorials/whatiswot/10-Building_Blocks/README.md new file mode 100644 index 00000000..0ed98889 --- /dev/null +++ b/Tutorials/whatiswot/10-Building_Blocks/README.md @@ -0,0 +1,119 @@ +# Building Blocks + +## Table of Contents + +- Explaining Building Block Concept +- TD +- Bindings +- Discovery +- Scripting API +- Profiles +- Summary + +## Preliminary Script + +- In this video, we give a short introduction to each building block of the Web of Things - Thing Description, Binding Templates, Discovery and Scripting API. Later, in separate videos, we will explore each individual building block in more detail. + +### But what are building blocks exactly? + +- Building blocks allow the implementation of systems that conform with the abstract WoT Architecture. Let's take a closer look at the WoT building blocks. + +- A Thing always has a TD - it is a key building block that provides metadata describing a Thing and its network interface. This TD can be shared directly by the Thing or through TD Directory – that is what we call Discovery. Things and consumers can be programmed with the Scripting API. + +### Thing Description + +- Let’s begin with the Thing Description – a key component of the WoT. + +- All TDs can be processed just like a normal JSON. Essentially, a TD defines an information model using a semantic vocabulary and a serialized JSON representation. It provides human and machine-readable metadata describing the capabilities of a Thing. + +- The TD describes Thing instances with general metadata such as name, ID, and description. Additionally, TDs can also contain Interaction Affordance metadata and use Protocol Bindings such as Modbus and HTTP as well as use both public and local IP addresses. + +- Here is an example of a TD. We can see the JSON serialization of a TD of a temperature controller. It tells the consumer to send a modbus request to read the temperature in the local network. The Thing can be proxied by a gateway where an HTTP request will be sent instead of a modbus request. + + + +```js +{ + "title":"Temperature Controller", + "properties":{ + "temperature":{ + "type":"integer", + "forms":[{ + "href":"modbus+tcp://192.168.1.50:183/1/1", + "modv:functionName":"readHoldingRegisters", + "contentType":"text/octet-stream;length=2" + }] + } + } +} + +``` + +```js +{ + "title":"Temperature Controller", + "properties":{ + "temperature":{ + "type":"integer", + "forms":[{ + "href":"https://mywotgateway.com/temperaturecontroller/properties/temperature", + "htv:methodName":"GET", + "contentType":"application/json" + }] + } + } +} + +``` + + + + + +### Bindings + +- The second building block is WoT Binding Templates. + +- The IoT uses a variety of protocols for accessing devices because no single protocol is enough to cover the different use cases and requirements. The challenge of the WoT is to enable interactions of a variety of different IoT platforms. + +- The Binding Templates address an application client to use the TD so that they can extract metadata of the protocols such as HTTP, Modbus and etc. In general, Binding Templates provide a collection of blueprints that give guidance on how to interact with different Things that use different transport protocols, and content types. + +### Discovery + +- The next building block is WoT Discovery. + +- WoT Thing Descriptions must be known or accessible to other systems and devices. + +- WoT Discovery accomplishes this by defining mechanisms for distributing and accessing WoT TD over the network. + +- These mechanisms are used to simplify access to Things and services, and support their integration. They are not limited to a local area network but they also support remote discovery. + +- Thing Description Directory service provides mechanisms to register, and retrieve WoT metadata and TDs after authentication and authorization. + +### Scripting API + +- Next one is an optional building block of W3C: WoT Scripting API. + +- It makes it easier to develop IoT applications by providing an ECMA Script-based API similar to the Web browser APIs. + + + +- “Once you get the TDs, you build apps”? +TODO: Needs more content + +### Profiles + +- By nature, TD is flexible and able to describe anything without any limitations. + +- In some cases, depending on the Thing’s purpose, it may be a good idea to limit the TD to prevent unnecessary implementation load. + +### Summary + +- To summarize, WoT enables implementing device logic by reusable scripts executed in a runtime system for IoT applications which aims to improve productivity and reduce integration costs. diff --git a/Tutorials/whatiswot/Project_Details/new_video_11_12_script_temp.md b/Tutorials/whatiswot/11-Applications in Smart Homes and Smart Cities/README.md similarity index 51% rename from Tutorials/whatiswot/Project_Details/new_video_11_12_script_temp.md rename to Tutorials/whatiswot/11-Applications in Smart Homes and Smart Cities/README.md index a63914e5..a4024626 100644 --- a/Tutorials/whatiswot/Project_Details/new_video_11_12_script_temp.md +++ b/Tutorials/whatiswot/11-Applications in Smart Homes and Smart Cities/README.md @@ -1,14 +1,19 @@ -# Video 11: Application and architecture patterns in Smart Homes and Smart Cities +# Applications in Smart Homes and Smart Cities -- In this two-part tutorial, we will introduce the W3C Web of Things by exploring its application domains and common architecture patterns. In this video our focus will be Smart Homes and Smart Cities. +## Table of Contents + +- Smart Homes +- Architecture Patterns + - Controllers + - Gateways +- Smart Cities -## Brief Introduction: +## Preliminary Script -- The WoT aims to preserve and complement existing IoT standards and solutions by providing a standardized approach for connecting and integrating smart devices, services, and applications into the Web. +- In this two-part tutorial, we will introduce the W3C Web of Things by exploring its application domains and common architecture patterns. In this video our focus will be Smart Homes and Smart Cities. -## Smart Homes +### Smart Homes -### Introduce smart homes: - In smart homes, the ability to connect and manage multiple assets remotely over the network is highly beneficial. - The interesting part about smart homes isn’t tied to a specific solution you buy, but rather in how WoT enables flexibility. Manufacturers can provide Thing Descriptions (TDs) for their devices, which lets anyone build and customize their own systems. By following these open standards, devices can communicate with each other across brands, allowing for seamless integration. This approach ensures that devices remain adaptable and private, and don’t become obsolete, as they can continuously support new use cases and technologies. @@ -17,7 +22,9 @@ **Graphic:** `House with many WoT-powered devices, showcasing Thing Description of the house` -### Architecture patterns: +#### Architecture patterns + +In smart homes, we can already notice common architecture patterns. In this video, we will explain Controller and Gateway patterns. 1. **Controllers:** @@ -35,48 +42,16 @@ **Graphic:** `Old Video 11 Cloud Gateway Animation` -## Smart cities - -### Introduce smart cities: +### Smart cities -- Similar to smart homes, monitoring of smart cities is possible. In this case, end users are different - from citizens to municipalities and government agencies. +- Similar to smart homes, monitoring of smart cities is possible. In this case, end users are different from citizens to municipalities and government agencies. -- Smart cities need to cover multiple domains like water management / air quality monitoring and etc. (Like a website selling cars/pumps/breaks (multiple things in one place)). Since WoT is open-source, it is reliable to be used by governments. +- Smart cities need to cover multiple domains like water management / air quality monitoring and etc. (Like a website selling cars/pumps/breaks (multiple things in one place)). Since WoT is composed of open standards, it can be reliably used by municipalities. - In smart cities, bridges, dams, and canals can be monitored for material conditions or deterioration for maintenance repair work to prevent significant damage. Parking slots and street lights can be monitored for crowd management and optimized usage too. -- Different managers who manage different Things - multiownership. Show TDs for every Thing. Since it’s so big there’s usually a mix of architectures. - -# Video 12: Application and architecture patterns in Industrial and Agriculture Systems - -## Brief introduction - -- Industrial applications of WoT involve more complex use cases compared to smart homes. - -- In industrial systems, devices from different manufacturers need to work together for a single use case. WoT supports this by accommodating various industry protocols, including legacy ones, ensuring seamless integration. The use of Thing Descriptions (TDs) allows devices to self-describe their capabilities, reducing the engineering effort needed to make them compatible. - -## Industrial systems - -### Introduce industrial systems: - -- Industrial applications may resemble smart home applications but have broad requirements for instance, advanced monitoring of the connected manufacturing equipment as well as the manufactured products and predictions of any possible machine failures. - -- Mention different protocols in factories and show TDs - - -## Agriculture systems - -### Introduce agriculture systems: - -- Another domain-specific application is in agriculture systems. - -- With WoT, soil conditions can be monitored and optimal plans for watering and fertilizing can be created. Depending on the need, agricultural devices can be controled remotely. Thus the quality and quantity of the harvest can be increased. - -### Architecture Patterns: - -1. **Cross-domain Collaboration** - -- In cross-domain collaborations, each system involves other systems in other domains. For example, Smart Factory with Smart City, Smart City with Smart Home. In those models, you can exchange information directly with each other in a peer-to-peer manner or indirectly via some collaboration platform. - +- Different managers who manage different Things - multiownership. +> Show TDs for every Thing. +Since it’s so big there’s usually a mix of architectures. diff --git a/Tutorials/whatiswot/12-Applications in Industrial and Agriculture Systems/README.md b/Tutorials/whatiswot/12-Applications in Industrial and Agriculture Systems/README.md new file mode 100644 index 00000000..ccdbb5d5 --- /dev/null +++ b/Tutorials/whatiswot/12-Applications in Industrial and Agriculture Systems/README.md @@ -0,0 +1,30 @@ +# Applications in Industrial and Agriculture Systems + +## Table of Contents + +- Brief Introduction +- Industrial Systems +- Agriculture Systems +- Cross-domain Collaboration + +## Preliminary Script + +- Industrial applications of WoT involve more complex use cases compared to smart homes. + +- In industrial systems, devices from different manufacturers need to work together for a single use case. WoT supports this by accommodating various industry protocols, including legacy ones, ensuring seamless integration. The use of Thing Descriptions (TDs) allows devices to self-describe their capabilities, reducing the engineering effort needed to make them compatible. + +### Industrial systems + +- Industrial applications may resemble smart home applications but have broad requirements for instance, advanced monitoring of the connected manufacturing equipment as well as the manufactured products and prediction of possible machine failures. + +- Mention different protocols in factories and show TDs + +### Agriculture systems + +- Another domain-specific application is in agriculture systems. + +- With WoT, soil conditions can be monitored and optimal plans for watering and fertilizing can be created. Depending on the need, agricultural devices can be controlled remotely. Thus the quality and quantity of the harvest can be increased. + +### Cross-domain Collaboration + +- In cross-domain collaborations, each system involves other systems in other domains. For example, Smart Factory with Smart City, Smart City with Smart Home. In those models, you can exchange information directly with each other in a peer-to-peer manner or indirectly via some collaboration platform. diff --git a/Tutorials/whatiswot/Project_Details/new_video_11_storyline_temp.md b/Tutorials/whatiswot/Project_Details/new_video_11_storyline_temp.md deleted file mode 100644 index 7320b0dd..00000000 --- a/Tutorials/whatiswot/Project_Details/new_video_11_storyline_temp.md +++ /dev/null @@ -1,10 +0,0 @@ -Video 11: Application and architecture patterns in Smart Homes and Smart Cities - -- Brief Introduction -- Smart Homes -- Remote Controllers -- Gateways -- Smart Cities - - - diff --git a/Tutorials/whatiswot/Project_Details/new_video_12_storyline_temp.md b/Tutorials/whatiswot/Project_Details/new_video_12_storyline_temp.md deleted file mode 100644 index e0469be3..00000000 --- a/Tutorials/whatiswot/Project_Details/new_video_12_storyline_temp.md +++ /dev/null @@ -1,6 +0,0 @@ -Video 12: Application and architecture patterns in Industrial and Agriculture Systems - -- Brief Introduction -- Industrial Systems -- Agriculture Systems -- Cross-domain Collaboration From 5416353ed6156a94e5feef205ebf5b81db713c6e Mon Sep 17 00:00:00 2001 From: Ege Korkan Date: Mon, 14 Oct 2024 13:22:00 +0200 Subject: [PATCH 4/6] Apply suggestions from code review Co-authored-by: Ted Thibodeau Jr --- .../whatiswot/10-Building_Blocks/README.md | 28 +++++++++---------- .../README.md | 20 ++++++------- .../README.md | 8 +++--- 3 files changed, 28 insertions(+), 28 deletions(-) diff --git a/Tutorials/whatiswot/10-Building_Blocks/README.md b/Tutorials/whatiswot/10-Building_Blocks/README.md index 0ed98889..9188d9d6 100644 --- a/Tutorials/whatiswot/10-Building_Blocks/README.md +++ b/Tutorials/whatiswot/10-Building_Blocks/README.md @@ -12,23 +12,23 @@ ## Preliminary Script -- In this video, we give a short introduction to each building block of the Web of Things - Thing Description, Binding Templates, Discovery and Scripting API. Later, in separate videos, we will explore each individual building block in more detail. +- In this video, we give a short introduction to each building block of the Web of Things — Thing Description, Binding Templates, Discovery, and Scripting API. Later, in separate videos, we will explore each individual building block in more detail. -### But what are building blocks exactly? +### But what are building blocks, exactly? - Building blocks allow the implementation of systems that conform with the abstract WoT Architecture. Let's take a closer look at the WoT building blocks. -- A Thing always has a TD - it is a key building block that provides metadata describing a Thing and its network interface. This TD can be shared directly by the Thing or through TD Directory – that is what we call Discovery. Things and consumers can be programmed with the Scripting API. +- A Thing always has a TD, a Thing Description. It is a key building block that provides metadata describing a Thing and its network interface. This TD can be shared directly by the Thing or through the TD Directory — which is what we call Discovery. Things and consumers can be programmed with the Scripting API. ### Thing Description -- Let’s begin with the Thing Description – a key component of the WoT. +- Let’s begin with the Thing Description, or TD — a key component of the WoT. -- All TDs can be processed just like a normal JSON. Essentially, a TD defines an information model using a semantic vocabulary and a serialized JSON representation. It provides human and machine-readable metadata describing the capabilities of a Thing. +- All TDs can be processed just like normal JSON documents. Essentially, a TD defines an information model using a semantic vocabulary and a serialized JSON representation. It provides human- and machine-readable metadata describing the capabilities of a Thing. -- The TD describes Thing instances with general metadata such as name, ID, and description. Additionally, TDs can also contain Interaction Affordance metadata and use Protocol Bindings such as Modbus and HTTP as well as use both public and local IP addresses. +- A TD describes a Thing instance with general metadata such as name, ID, and description. A TD can also contain Interaction Affordance metadata and Protocol Bindings such as Modbus and HTTP, as well as both public and local IP addresses. -- Here is an example of a TD. We can see the JSON serialization of a TD of a temperature controller. It tells the consumer to send a modbus request to read the temperature in the local network. The Thing can be proxied by a gateway where an HTTP request will be sent instead of a modbus request. +- Here is an example of a TD. This is the JSON serialization of a TD of a temperature controller. It tells the consumer to send a Modbus request to read the temperature in the local network. The Thing can be proxied by a gateway where an HTTP request will be sent instead of a Modbus request. ``` - + - The IoT uses a variety of protocols for accessing devices because no single protocol is enough to cover the different use cases and requirements. The challenge of the WoT is to enable interactions of a variety of different IoT platforms. -- The Binding Templates address an application client to use the TD so that they can extract metadata of the protocols such as HTTP, Modbus and etc. In general, Binding Templates provide a collection of blueprints that give guidance on how to interact with different Things that use different transport protocols, and content types. +- The Binding Templates address an application client to use the TD so that they can extract metadata of the protocols such as HTTP, Modbus, etc. In general, Binding Templates provide a collection of blueprints that give guidance on how to interact with different Things that use different transport protocols and content types. ### Discovery @@ -93,17 +93,17 @@ ALL OF THIS AFTER BINDINGS --> - WoT Discovery accomplishes this by defining mechanisms for distributing and accessing WoT TD over the network. -- These mechanisms are used to simplify access to Things and services, and support their integration. They are not limited to a local area network but they also support remote discovery. +- These mechanisms are used to simplify access to Things and services, and to support their integration. They are not limited to a local area network; they also support remote discovery. -- Thing Description Directory service provides mechanisms to register, and retrieve WoT metadata and TDs after authentication and authorization. +- Thing Description Directory service provides mechanisms to register and retrieve WoT metadata and TDs after authentication and authorization. ### Scripting API -- Next one is an optional building block of W3C: WoT Scripting API. +- Next is an optional building block of W3C, the WoT Scripting API. -- It makes it easier to develop IoT applications by providing an ECMA Script-based API similar to the Web browser APIs. +- The Scripting API makes it easier to develop IoT applications by providing an ECMAScript-based API, similar to the Web browser APIs. - + - “Once you get the TDs, you build apps”? TODO: Needs more content diff --git a/Tutorials/whatiswot/11-Applications in Smart Homes and Smart Cities/README.md b/Tutorials/whatiswot/11-Applications in Smart Homes and Smart Cities/README.md index a4024626..858c1927 100644 --- a/Tutorials/whatiswot/11-Applications in Smart Homes and Smart Cities/README.md +++ b/Tutorials/whatiswot/11-Applications in Smart Homes and Smart Cities/README.md @@ -10,25 +10,25 @@ ## Preliminary Script -- In this two-part tutorial, we will introduce the W3C Web of Things by exploring its application domains and common architecture patterns. In this video our focus will be Smart Homes and Smart Cities. +- In this two-part tutorial, we will introduce the W3C Web of Things by exploring its application domains and common architecture patterns. In this video, our focus will be Smart Homes and Smart Cities. ### Smart Homes - In smart homes, the ability to connect and manage multiple assets remotely over the network is highly beneficial. -- The interesting part about smart homes isn’t tied to a specific solution you buy, but rather in how WoT enables flexibility. Manufacturers can provide Thing Descriptions (TDs) for their devices, which lets anyone build and customize their own systems. By following these open standards, devices can communicate with each other across brands, allowing for seamless integration. This approach ensures that devices remain adaptable and private, and don’t become obsolete, as they can continuously support new use cases and technologies. +- The interesting aspect of smart homes isn’t tied to a specific solution you buy, but rather in how WoT enables flexibility. Manufacturers can provide Thing Descriptions (TDs) for their devices, which lets anyone build and customize their own systems. By following these open standards, devices can communicate with each other across brands, allowing for seamless integration. This approach ensures that devices remain adaptable and private, and don’t become obsolete, as they can continuously support new use cases and technologies. -- This helps within various activities within the home, such as controlling lights, adjusting room temperature, managing home appliances, and enhancing security using smartphones. These capabilities enable optimization of energy and resource consumption. +- This helps with various activities within the home, such as controlling lights, adjusting room temperature, managing home appliances, and enhancing security using smartphones. These capabilities enable optimization of energy and resource consumption. **Graphic:** `House with many WoT-powered devices, showcasing Thing Description of the house` #### Architecture patterns -In smart homes, we can already notice common architecture patterns. In this video, we will explain Controller and Gateway patterns. +In smart homes, we can see common architecture patterns. In this video, we will explain Controller and Gateway patterns. 1. **Controllers:** -- A common pattern involves using a controller, both locally and remotely, to interact with devices via the home network by consuming the Thing Description. +- A common pattern involves using a controller, locally and/or remotely, to interact with devices on the home network by consuming the Thing Description. - Devices are represented by TDs and act as servers, responding to commands from client controllers (e.g., smartphones) for actions such as adjusting settings or activating sensors. @@ -44,14 +44,14 @@ In smart homes, we can already notice common architecture patterns. In this vide ### Smart cities -- Similar to smart homes, monitoring of smart cities is possible. In this case, end users are different from citizens to municipalities and government agencies. +- Similar to smart homes, monitoring of smart cities via the Web of Thigns is possible. In this case, end users are akin to citizens of municipalities and government agencies. -- Smart cities need to cover multiple domains like water management / air quality monitoring and etc. (Like a website selling cars/pumps/breaks (multiple things in one place)). Since WoT is composed of open standards, it can be reliably used by municipalities. +- Smart cities need to cover multiple domains like water management, air quality monitoring, etc., similar to a website selling cars, pumps, brakes — i.e., multiple things in one place. Since WoT is composed of open standards, it can be reliably used by municipalities. -- In smart cities, bridges, dams, and canals can be monitored for material conditions or deterioration for maintenance repair work to prevent significant damage. Parking slots and street lights can be monitored for crowd management and optimized usage too. +- In smart cities, bridges, dams, and canals can be monitored for material conditions and deterioration calling for maintenance repair work to prevent significant damage. Parking spaces and street lights can be monitored for crowd management and optimized usage, too. -- Different managers who manage different Things - multiownership. +- Different managers who manage different Things — multi-ownership. > Show TDs for every Thing. -Since it’s so big there’s usually a mix of architectures. +Since it’s so big, there’s usually a mix of architectures. diff --git a/Tutorials/whatiswot/12-Applications in Industrial and Agriculture Systems/README.md b/Tutorials/whatiswot/12-Applications in Industrial and Agriculture Systems/README.md index ccdbb5d5..88671a64 100644 --- a/Tutorials/whatiswot/12-Applications in Industrial and Agriculture Systems/README.md +++ b/Tutorials/whatiswot/12-Applications in Industrial and Agriculture Systems/README.md @@ -9,13 +9,13 @@ ## Preliminary Script -- Industrial applications of WoT involve more complex use cases compared to smart homes. +- Industrial applications of WoT involves more complex use cases than smart homes. - In industrial systems, devices from different manufacturers need to work together for a single use case. WoT supports this by accommodating various industry protocols, including legacy ones, ensuring seamless integration. The use of Thing Descriptions (TDs) allows devices to self-describe their capabilities, reducing the engineering effort needed to make them compatible. ### Industrial systems -- Industrial applications may resemble smart home applications but have broad requirements for instance, advanced monitoring of the connected manufacturing equipment as well as the manufactured products and prediction of possible machine failures. +- Industrial applications may resemble smart home applications but have broader requirements, such as advanced monitoring of connected manufacturing equipment as well as the manufactured products and prediction of possible machine failure. - Mention different protocols in factories and show TDs @@ -23,8 +23,8 @@ - Another domain-specific application is in agriculture systems. -- With WoT, soil conditions can be monitored and optimal plans for watering and fertilizing can be created. Depending on the need, agricultural devices can be controlled remotely. Thus the quality and quantity of the harvest can be increased. +- With WoT, soil conditions can be monitored and optimal plans for watering and fertilizing can be created. Depending on the need, agricultural devices can be controlled remotely. Thus, the quality and quantity of the harvest can be increased. ### Cross-domain Collaboration -- In cross-domain collaborations, each system involves other systems in other domains. For example, Smart Factory with Smart City, Smart City with Smart Home. In those models, you can exchange information directly with each other in a peer-to-peer manner or indirectly via some collaboration platform. +- In cross-domain collaborations, each system involves other systems in other domains. For example, Smart Factory with Smart City, Smart City with Smart Home. In these models, information can be exchanged directly between systems in a peer-to-peer manner or indirectly via collaboration platforms. From 327d0eaa1126450c28a401a5255dbed44a900f1b Mon Sep 17 00:00:00 2001 From: Teodor Date: Tue, 5 Nov 2024 15:24:09 +0100 Subject: [PATCH 5/6] apply feedback and polish scripts further --- .../README.md | 20 ++++++------ .../README.md | 32 +++++++++++++++---- 2 files changed, 36 insertions(+), 16 deletions(-) diff --git a/Tutorials/whatiswot/11-Applications in Smart Homes and Smart Cities/README.md b/Tutorials/whatiswot/11-Applications in Smart Homes and Smart Cities/README.md index 858c1927..cd9cac49 100644 --- a/Tutorials/whatiswot/11-Applications in Smart Homes and Smart Cities/README.md +++ b/Tutorials/whatiswot/11-Applications in Smart Homes and Smart Cities/README.md @@ -18,13 +18,13 @@ - The interesting aspect of smart homes isn’t tied to a specific solution you buy, but rather in how WoT enables flexibility. Manufacturers can provide Thing Descriptions (TDs) for their devices, which lets anyone build and customize their own systems. By following these open standards, devices can communicate with each other across brands, allowing for seamless integration. This approach ensures that devices remain adaptable and private, and don’t become obsolete, as they can continuously support new use cases and technologies. -- This helps with various activities within the home, such as controlling lights, adjusting room temperature, managing home appliances, and enhancing security using smartphones. These capabilities enable optimization of energy and resource consumption. +- This helps with various activities within the home, such as controlling lights, adjusting room temperature, managing home appliances, and enhancing security using smartphones. These capabilities optimize energy and resource consumption. **Graphic:** `House with many WoT-powered devices, showcasing Thing Description of the house` #### Architecture patterns -In smart homes, we can see common architecture patterns. In this video, we will explain Controller and Gateway patterns. +Now that we’ve covered the basics of smart homes, let’s take a closer look at the architecture patterns that enable these systems to work efficiently. 1. **Controllers:** @@ -36,22 +36,24 @@ In smart homes, we can see common architecture patterns. In this video, we will 2. **Gateways:** -- Consumer can control it both locally or fully remotely. +- Gateways are another pattern commonly found in Smart Homes. + - Gateways connect home networks to the internet, enabling remote management and monitoring. + +- They can use the local TD of a device and provide web-level access management, allowing devices to be accessed and managed both locally and remotely over the web. Internally, the device uses an app for local control, while externally, a protocol is used to manage remote interactions. + - They facilitate communication between local devices and external controllers, enhancing accessibility and control. **Graphic:** `Old Video 11 Cloud Gateway Animation` ### Smart cities -- Similar to smart homes, monitoring of smart cities via the Web of Thigns is possible. In this case, end users are akin to citizens of municipalities and government agencies. - -- Smart cities need to cover multiple domains like water management, air quality monitoring, etc., similar to a website selling cars, pumps, brakes — i.e., multiple things in one place. Since WoT is composed of open standards, it can be reliably used by municipalities. +- In smart cities, WoT's domain-agnostic nature enables scalability across various municipal systems, making it more flexible than traditional IoT solutions. -- In smart cities, bridges, dams, and canals can be monitored for material conditions and deterioration calling for maintenance repair work to prevent significant damage. Parking spaces and street lights can be monitored for crowd management and optimized usage, too. +- WoT's ability to seamlessly integrate different domains — such as water management, air quality monitoring, and traffic control — makes it a perfect fit for urban environments. WoT leverages open standards like Thing Descriptions (TDs) and built-in web protocols in addition to traditional IoT protocols and this allows devices from different systems and manufacturers to communicate. -- Different managers who manage different Things — multi-ownership. +- This flexibility ensures smart cities can scale as needed, adding new devices and systems without being tied to a single vendor or technology. Multi-ownership also becomes an option - different organisations or managers oversee different Things, while WoT ensures seamless interoperability across all of them. > Show TDs for every Thing. -Since it’s so big, there’s usually a mix of architectures. +- Additionally, WoT's use of open standards supports a wide range of protocols, making it adaptable to various architectures, whether client-server or publish-subscribe, with or without cloud involvement. This versatility allows smart cities to choose the best approach for their infrastructure. diff --git a/Tutorials/whatiswot/12-Applications in Industrial and Agriculture Systems/README.md b/Tutorials/whatiswot/12-Applications in Industrial and Agriculture Systems/README.md index 88671a64..969f8364 100644 --- a/Tutorials/whatiswot/12-Applications in Industrial and Agriculture Systems/README.md +++ b/Tutorials/whatiswot/12-Applications in Industrial and Agriculture Systems/README.md @@ -9,22 +9,40 @@ ## Preliminary Script -- Industrial applications of WoT involves more complex use cases than smart homes. +- The Web of Things finds applications in diverse fields beyond smart homes and cities, with industrial and agriculture systems being two major and complex examples. -- In industrial systems, devices from different manufacturers need to work together for a single use case. WoT supports this by accommodating various industry protocols, including legacy ones, ensuring seamless integration. The use of Thing Descriptions (TDs) allows devices to self-describe their capabilities, reducing the engineering effort needed to make them compatible. +- First we'll take a look at industrial systems. ### Industrial systems -- Industrial applications may resemble smart home applications but have broader requirements, such as advanced monitoring of connected manufacturing equipment as well as the manufactured products and prediction of possible machine failure. +- Industrial applications may often resemble smart home applications, but have broader requirements. These include advanced monitoring of connected manufacturing equipment, tracking manufactured products and predicting possible machine failures. -- Mention different protocols in factories and show TDs +- In factories for example, devices from multiple manufacturers must work together seamlessly. WoT simplifies this by accommodating a variety of industrial protocols, including legacy ones. Each device comes equipped with its own Thing Description, making it clear to other devices and systems how to interact with it, and thus reducing complexity and engineering effort. + +**Code: Graphic of many devices in a factory with their own TDs working together** ### Agriculture systems -- Another domain-specific application is in agriculture systems. +- Moving on to another domain-specific application of WoT - agriculture systems. Agriculture offers a wide range of automation possibilities, from monitoring soil moisture and automating watering to fertilization schedules and machinery operation. However, finding a single solution that fits all needs is challenging, especially for small and medium-sized farms. These farmers often aim to automate just one specific task, like soil monitoring, for example. + +- WoT plays a crucial role as an interoperable interface here, allowing these farmers to integrate just the parts they need without committing to an all-encompassing solution. By enabling flexibility and compatibility across different devices and systems, WoT makes it easier for farms to adopt new solutions at their own pace and budget. + +- Agriculture systems also come with their own set of constraints. Often, devices in agricultural environments are constrained in terms of power and connectivity. For example, sensors in a cornfield may not have access to power sources or network cables and rely on batteries. WoT accommodates these constraints by allowing data to be transmitted only when the device is online, helping conserve energy and avoid unnecessary power drain. + +**Animation visualising the WoT mechanism in resource-constrained devices** -- With WoT, soil conditions can be monitored and optimal plans for watering and fertilizing can be created. Depending on the need, agricultural devices can be controlled remotely. Thus, the quality and quantity of the harvest can be increased. +- Thus WoT's functionality ensures it is both practical and efficient without adding any unnecessary complexity. ### Cross-domain Collaboration -- In cross-domain collaborations, each system involves other systems in other domains. For example, Smart Factory with Smart City, Smart City with Smart Home. In these models, information can be exchanged directly between systems in a peer-to-peer manner or indirectly via collaboration platforms. +- Thanks to the interoperability of WoT, cross-domain collaborations are also made possible. In cross-domain collaborations, each system involves other systems in other domains. For example, Smart Factory with Smart City, Smart City with Smart Home. In these models, information can be exchanged directly between systems in a peer-to-peer manner or indirectly via collaboration platforms. + +### Summary + +- To summarize, WoT provides numerous advantages across its applications: + - It is domain-agnostic, allowing for seamless integration across various systems. + - It supports multiple protocols, ensuring interoperability among devices from different manufacturers. + - WoT is built on open standards, promoting long-term adaptability and innovation. + - It works with resource-constrained devices, edge or the cloud. + +By enabling efficient and secure interactions between devices across different domains, WoT serves as a transformative framework. From 77142d4dd99748e314dd811d517f559831710ef5 Mon Sep 17 00:00:00 2001 From: Ege Korkan Date: Fri, 8 Nov 2024 12:42:16 +0100 Subject: [PATCH 6/6] Apply suggestions from code review Co-authored-by: Ted Thibodeau Jr --- .../README.md | 2 +- .../README.md | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Tutorials/whatiswot/11-Applications in Smart Homes and Smart Cities/README.md b/Tutorials/whatiswot/11-Applications in Smart Homes and Smart Cities/README.md index cd9cac49..153404a8 100644 --- a/Tutorials/whatiswot/11-Applications in Smart Homes and Smart Cities/README.md +++ b/Tutorials/whatiswot/11-Applications in Smart Homes and Smart Cities/README.md @@ -52,7 +52,7 @@ Now that we’ve covered the basics of smart homes, let’s take a closer look a - WoT's ability to seamlessly integrate different domains — such as water management, air quality monitoring, and traffic control — makes it a perfect fit for urban environments. WoT leverages open standards like Thing Descriptions (TDs) and built-in web protocols in addition to traditional IoT protocols and this allows devices from different systems and manufacturers to communicate. -- This flexibility ensures smart cities can scale as needed, adding new devices and systems without being tied to a single vendor or technology. Multi-ownership also becomes an option - different organisations or managers oversee different Things, while WoT ensures seamless interoperability across all of them. +- This flexibility ensures smart cities can scale as needed, adding new devices and systems without being tied to a single vendor or technology. Multi-ownership also becomes an option — different organisations or managers oversee different Things, while WoT ensures seamless interoperability across all of them. > Show TDs for every Thing. diff --git a/Tutorials/whatiswot/12-Applications in Industrial and Agriculture Systems/README.md b/Tutorials/whatiswot/12-Applications in Industrial and Agriculture Systems/README.md index 969f8364..4b6afca1 100644 --- a/Tutorials/whatiswot/12-Applications in Industrial and Agriculture Systems/README.md +++ b/Tutorials/whatiswot/12-Applications in Industrial and Agriculture Systems/README.md @@ -15,17 +15,17 @@ ### Industrial systems -- Industrial applications may often resemble smart home applications, but have broader requirements. These include advanced monitoring of connected manufacturing equipment, tracking manufactured products and predicting possible machine failures. +- Industrial applications may often resemble smart home applications, but have broader requirements. These include advanced monitoring of connected manufacturing equipment, tracking manufactured products, and predicting possible machine failures. -- In factories for example, devices from multiple manufacturers must work together seamlessly. WoT simplifies this by accommodating a variety of industrial protocols, including legacy ones. Each device comes equipped with its own Thing Description, making it clear to other devices and systems how to interact with it, and thus reducing complexity and engineering effort. +- In factories, for example, devices from multiple manufacturers must work together seamlessly. WoT simplifies this by accommodating a variety of industrial protocols, including legacy protocols. Each device comes equipped with its own Thing Description, making it clear to other devices and systems how to interact with it, thereby reducing complexity and engineering effort. -**Code: Graphic of many devices in a factory with their own TDs working together** +**Code: Graphic of many devices with their own TDs, working together in a factory** ### Agriculture systems -- Moving on to another domain-specific application of WoT - agriculture systems. Agriculture offers a wide range of automation possibilities, from monitoring soil moisture and automating watering to fertilization schedules and machinery operation. However, finding a single solution that fits all needs is challenging, especially for small and medium-sized farms. These farmers often aim to automate just one specific task, like soil monitoring, for example. +- Moving on to another domain-specific application of WoT — agriculture systems. Agriculture offers a wide range of automation possibilities, from monitoring soil moisture and automating watering, to handling fertilization schedules and machinery operation. However, finding a single solution that fits all needs is challenging, especially for small and medium-sized farms. These farmers often aim to automate just one specific task, like soil monitoring, for example. -- WoT plays a crucial role as an interoperable interface here, allowing these farmers to integrate just the parts they need without committing to an all-encompassing solution. By enabling flexibility and compatibility across different devices and systems, WoT makes it easier for farms to adopt new solutions at their own pace and budget. +- WoT plays a crucial role as an interoperable interface here, allowing these farmers to integrate only the parts they need without committing to an all-encompassing solution. By enabling flexibility and compatibility across different devices and systems, WoT makes it easier for farms to adopt new solutions at their own pace and budget. - Agriculture systems also come with their own set of constraints. Often, devices in agricultural environments are constrained in terms of power and connectivity. For example, sensors in a cornfield may not have access to power sources or network cables and rely on batteries. WoT accommodates these constraints by allowing data to be transmitted only when the device is online, helping conserve energy and avoid unnecessary power drain.