Merge pull request #259 from RWTH-EBC/255-ngsi_v2-tutorials-are-deprecated

fix: ngsi v2 tutorials are deprecated (#255)

Author: djs0109

CHANGELOG.md

@@ -3,6 +3,7 @@
 - add: tutorials for multi-entity ([#260](https://github.com/RWTH-EBC/FiLiP/pull/260))
 - add: add ``update_entity_relationships`` to allow relationship update ([#271](https://github.com/RWTH-EBC/FiLiP/pull/271))
 - add: flag to determine the deletion of registration when clearing the CB ([#267](https://github.com/RWTH-EBC/FiLiP/pull/267))
+- fix: rework tutorials for pydantic v2 ([#259](https://github.com/RWTH-EBC/FiLiP/pull/259))
 
 ### v0.4.1
 - fix: Session added as optional parameter to enable tls communication with clients ([#249](https://github.com/RWTH-EBC/FiLiP/pull/249))

filip/models/ngsi_v2/iot.py

@@ -221,7 +221,7 @@ def validate_cbHost(cls, value):
         Returns:
             timezone
         """
-        return str(value)
+        return str(value) if value else value
     lazy: Optional[List[LazyDeviceAttribute]] = Field(
         default=[],
         desription="list of common lazy attributes of the device. For each "

tutorials/ngsi_v2/e1_virtual_weatherstation/e1_virtual_weatherstation.py

@@ -3,7 +3,7 @@
 
 # Create a virtual IoT device that simulates the ambient temperature and
 # publishes it via MQTT. The simulation function is already predefined.
-# This exercise to give a simple introduction to the communication via MQTT.
+# This exercise gives a simple introduction to the communication via MQTT.
 
 # The input sections are marked with 'ToDo'
 
@@ -31,16 +31,15 @@
 # import simulation model
 from tutorials.ngsi_v2.simulation_model import SimulationModel
 
-
 # ## Parameters
-# ToDo: Enter your mqtt broker url and port, e.g mqtt://test.mosquitto.org:1883
+# ToDo: Enter your mqtt broker url and port, e.g. mqtt://test.mosquitto.org:1883.
 MQTT_BROKER_URL = "mqtt://test.mosquitto.org:1883"
-# ToDo: If required enter your username and password
+# ToDo: If required, enter your username and password.
 MQTT_USER = ""
-MQTT_PW =  ""
+MQTT_PW = ""
 
 # ToDo: Create a unique topic that your weather station will publish on,
-#  e.g. by using a uuid
+#  e.g. by using a uuid.
 UNIQUE_ID = str(uuid4())
 TOPIC_WEATHER_STATION = f"fiware_workshop/{UNIQUE_ID}/weather_station"
 
@@ -50,8 +49,7 @@
 
 T_SIM_START = 0  # simulation start time in seconds
 T_SIM_END = 24 * 60 * 60  # simulation end time in seconds
-COM_STEP = 60 * 60 * 0.25  # 15 min communication step in seconds
-
+COM_STEP = 60 * 60  # 60 min communication step in seconds
 
 # ## Main script
 if __name__ == '__main__':
@@ -64,22 +62,23 @@
     # define a list for storing historical data
     history_weather_station = []
 
-    # ToDo: create a MQTTv5 client with paho-mqtt
+    # ToDo: Create an MQTTv5 client with paho-mqtt.
     mqttc = ...
     # set user data if required
     mqttc.username_pw_set(username=MQTT_USER, password=MQTT_PW)
+
     # ToDo: Define a callback function that will be executed when the client
     #  receives message on a subscribed topic. It should decode your message
-    #  and store the information for later in our history
-    #  Note: do not change function's signature
+    #  and store the information for later in our history.
+    #  Note: Do not change the function's signature!
     def on_message(client, userdata, msg):
         """
         Callback function for incoming messages
         """
         # decode the payload
         payload = msg.payload.decode('utf-8')
         # ToDo: Parse the payload using the `json` package and write it to
-        #  the history
+        #  the history.
         ...
 
         pass
@@ -88,7 +87,7 @@ def on_message(client, userdata, msg):
     # or a topic specific callback with `mqttc.message_callback_add()`
     mqttc.on_message = on_message
 
-    # ToDO: connect to the mqtt broker and subscribe to your topic
+    # ToDo: Connect to the mqtt broker and subscribe to your topic.
     mqtt_url = urlparse(MQTT_BROKER_URL)
     ...
 
@@ -98,27 +97,27 @@ def on_message(client, userdata, msg):
 
 
 
-    # ToDo: print and subscribe to the weather station topic
+    # ToDo: Print and subscribe to the weather station topic.
     print(f"WeatherStation topic:\n {TOPIC_WEATHER_STATION}")
     mqttc.subscribe(topic=TOPIC_WEATHER_STATION)
 
     # create a non-blocking thread for mqtt communication
     mqttc.loop_start()
 
-    # ToDo: Create a loop that publishes every second a message to the broker
+    # ToDo: Create a loop that publishes every 0.2 seconds a message to the broker
     #  that holds the simulation time "t_sim" and the corresponding temperature
-    #  "t_amb"
+    #  "t_amb".
     for t_sim in range(sim_model.t_start,
                        int(sim_model.t_end + COM_STEP),
                        int(COM_STEP)):
-        # ToDo: publish the simulated ambient temperature
+        # ToDo: Publish the simulated ambient temperature.
         ...
 
 
 
         # simulation step for next loop
         sim_model.do_step(int(t_sim + COM_STEP))
-        time.sleep(1)
+        time.sleep(0.2)
 
     # close the mqtt listening thread
     mqttc.loop_stop()
@@ -127,9 +126,9 @@ def on_message(client, userdata, msg):
 
     # plot results
     fig, ax = plt.subplots()
-    t_simulation = [item["t_sim"] for item in history_weather_station]
+    t_simulation = [item["t_sim"]/3600 for item in history_weather_station]
     temperature = [item["t_amb"] for item in history_weather_station]
     ax.plot(t_simulation, temperature)
-    ax.set_xlabel('time in s')
+    ax.set_xlabel('time in h')
     ax.set_ylabel('ambient temperature in °C')
     plt.show()

tutorials/ngsi_v2/e1_virtual_weatherstation/e1_virtual_weatherstation_solution.py

@@ -3,7 +3,7 @@
 
 # Create a virtual IoT device that simulates the ambient temperature and
 # publishes it via MQTT. The simulation function is already predefined.
-# This exercise to give a simple introduction to the communication via MQTT.
+# This exercise gives a simple introduction to the communication via MQTT.
 
 # The input sections are marked with 'ToDo'
 
@@ -31,16 +31,15 @@
 # import simulation model
 from tutorials.ngsi_v2.simulation_model import SimulationModel
 
-
 # ## Parameters
-# ToDo: Enter your mqtt broker url and port, e.g mqtt://test.mosquitto.org:1883
-MQTT_BROKER_URL =  "mqtt://test.mosquitto.org:1883"
-# ToDo: If required enter your username and password
+# ToDo: Enter your mqtt broker url and port, e.g. mqtt://test.mosquitto.org:1883.
+MQTT_BROKER_URL = "mqtt://test.mosquitto.org:1883"
+# ToDo: If required, enter your username and password.
 MQTT_USER = ""
-MQTT_PW =  ""
+MQTT_PW = ""
 
 # ToDo: Create a unique topic that your weather station will publish on,
-#  e.g. by using a uuid
+#  e.g. by using a uuid.
 UNIQUE_ID = str(uuid4())
 TOPIC_WEATHER_STATION = f"fiware_workshop/{UNIQUE_ID}/weather_station"
 
@@ -50,8 +49,7 @@
 
 T_SIM_START = 0  # simulation start time in seconds
 T_SIM_END = 24 * 60 * 60  # simulation end time in seconds
-COM_STEP = 60 * 60 * 1  # 60 min communication step in seconds
-
+COM_STEP = 60 * 60  # 60 min communication step in seconds
 
 # ## Main script
 if __name__ == '__main__':
@@ -61,34 +59,34 @@
                                 temp_max=TEMPERATURE_MAX,
                                 temp_min=TEMPERATURE_MIN)
 
-    # define lists to store historical data
+    # define a list for storing historical data
     history_weather_station = []
 
-    # ToDo: create a MQTTv5 client with paho-mqtt
+    # ToDo: Create an MQTTv5 client with paho-mqtt.
     mqttc = mqtt.Client(protocol=mqtt.MQTTv5)
     # set user data if required
     mqttc.username_pw_set(username=MQTT_USER, password=MQTT_PW)
+
     # ToDo: Define a callback function that will be executed when the client
     #  receives message on a subscribed topic. It should decode your message
-    #  and store the information for later in our history
-    #  Note: do not change function's signature!
+    #  and store the information for later in our history.
+    #  Note: Do not change the function's signature!
     def on_message(client, userdata, msg):
         """
         Callback function for incoming messages
         """
         # decode the payload
         payload = msg.payload.decode('utf-8')
         # ToDo: Parse the payload using the `json` package and write it to
-        #  the history
+        #  the history.
         history_weather_station.append(json.loads(payload))
 
 
-
     # add your callback function to the client. You can either use a global
     # or a topic specific callback with `mqttc.message_callback_add()`
     mqttc.on_message = on_message
 
-    # ToDO: connect to the mqtt broker and subscribe to your topic
+    # ToDo: Connect to the mqtt broker and subscribe to your topic.
     mqtt_url = urlparse(MQTT_BROKER_URL)
     mqttc.connect(host=mqtt_url.hostname,
                   port=mqtt_url.port,
@@ -98,27 +96,27 @@ def on_message(client, userdata, msg):
                   clean_start=mqtt.MQTT_CLEAN_START_FIRST_ONLY,
                   properties=None)
 
-    # ToDo: print and subscribe to the weather station topic
+    # ToDo: Print and subscribe to the weather station topic.
     print(f"WeatherStation topic:\n {TOPIC_WEATHER_STATION}")
     mqttc.subscribe(topic=TOPIC_WEATHER_STATION)
 
     # create a non-blocking thread for mqtt communication
     mqttc.loop_start()
 
-    # ToDo: Create a loop that publishes every second a message to the broker
+    # ToDo: Create a loop that publishes every 0.2 seconds a message to the broker
     #  that holds the simulation time "t_sim" and the corresponding temperature
-    #  "t_amb"
+    #  "t_amb".
     for t_sim in range(sim_model.t_start,
                        int(sim_model.t_end + COM_STEP),
                        int(COM_STEP)):
-        # ToDo: publish the simulated ambient temperature
+        # ToDo: Publish the simulated ambient temperature.
         mqttc.publish(topic=TOPIC_WEATHER_STATION,
                       payload=json.dumps({"t_amb": sim_model.t_amb,
                                           "t_sim": sim_model.t_sim}))
 
         # simulation step for next loop
         sim_model.do_step(int(t_sim + COM_STEP))
-        time.sleep(1)
+        time.sleep(0.2)
 
     # close the mqtt listening thread
     mqttc.loop_stop()
@@ -127,9 +125,9 @@ def on_message(client, userdata, msg):
 
     # plot results
     fig, ax = plt.subplots()
-    t_simulation = [item["t_sim"] for item in history_weather_station]
+    t_simulation = [item["t_sim"]/3600 for item in history_weather_station]
     temperature = [item["t_amb"] for item in history_weather_station]
     ax.plot(t_simulation, temperature)
-    ax.set_xlabel('time in s')
+    ax.set_xlabel('time in h')
     ax.set_ylabel('ambient temperature in °C')
     plt.show()

tutorials/ngsi_v2/e2_healthcheck/e2_healthcheck.py

@@ -1,14 +1,14 @@
 """
 # # Exercise 2: Service Health Check
 
-# Create one or multiple filip clients and check if the corresponding services
+# Create one or multiple FiLiP clients and check if the corresponding services
 # are up and running by accessing their version information.
 
 # The input sections are marked with 'ToDo'
 
 # #### Steps to complete:
 # 1. Set up the missing parameters in the parameter section
-# 2. Create filip ngsi_v2 clients for the individual services and check for
+# 2. Create FiLiP ngsi_v2 clients for the individual services and check for
 #   their version
 # 3. Create a config object for the ngsi_v2 multi client (HttpClient),
 #   create the multi client and again check for services' versions
@@ -23,29 +23,32 @@
     QuantumLeapClient
 
 # ## Parameters
-# ToDo: Enter your context broker url and port, e.g. http://localhost:1026
+# ToDo: Enter your context broker url and port, e.g. http://localhost:1026.
 CB_URL = "http://localhost:1026"
-# ToDo: Enter your IoT-Agent url and port, e.g. http://localhost:4041
+# ToDo: Enter your IoT-Agent url and port, e.g. http://localhost:4041.
 IOTA_URL = "http://localhost:4041"
-# ToDo: Enter your QuantumLeap url and port, e.g. http://localhost:8668
+# ToDo: Enter your QuantumLeap url and port, e.g. http://localhost:8668.
 QL_URL = "http://localhost:8668"
 
 # ## Main script
 if __name__ == "__main__":
-    # Create a single client for each service and check the service for
-    #  its version
+    # ToDo: Create a single client for each service and check the service for
+    #  its version.
     cbc = ContextBrokerClient(url=CB_URL)
-    print(cbc.get_version())
+    print(f"Context Broker Client: {cbc.get_version()}")
 
     iotac = ...
+    print(f"IoTA Client: {iotac.get_version()}")
 
     qlc = ...
+    print(f"Quantum Leap Client: {qlc.get_version()}")
 
-    # ToDo: Create a configuration object for a multi client
+    # ToDo: Create a configuration object for a multi client.
     config = HttpClientConfig(...)
 
-    # ToDo: Create a multi client check again all services for their version
+    # ToDo: Create a multi client check again all services for their version.
     multic = HttpClient(config=config)
 
-    print(multic.cb.get_version())
-    ...
+    print(f"Multi Client (Context Broker): {multic.cb.get_version()}\n"
+          f"Multi Client (IoTA): {multic.iota.get_version()}\n"
+          f"Multi Client (Quantum Leap): {multic.timeseries.get_version()}")

tutorials/ngsi_v2/e2_healthcheck/e2_healthcheck_solution.py

@@ -1,14 +1,14 @@
 """
 # # Exercise 2: Service Health Check
 
-# Create one or multiple filip clients and check if the corresponding services
+# Create one or multiple FiLiP clients and check if the corresponding services
 # are up and running by accessing their version information.
 
 # The input sections are marked with 'ToDo'
 
 # #### Steps to complete:
 # 1. Set up the missing parameters in the parameter section
-# 2. Create filip ngsi_v2 clients for the individual services and check for
+# 2. Create FiLiP ngsi_v2 clients for the individual services and check for
 #   their version
 # 3. Create a config object for the ngsi_v2 multi client (HttpClient),
 #   create the multi client and again check for services' versions
@@ -23,32 +23,32 @@
     QuantumLeapClient
 
 # ## Parameters
-# ToDo: Enter your context broker url and port, e.g. http://localhost:1026
+# ToDo: Enter your context broker url and port, e.g. http://localhost:1026.
 CB_URL = "http://localhost:1026"
-# ToDo: Enter your IoT-Agent url and port, e.g. http://localhost:4041
+# ToDo: Enter your IoT-Agent url and port, e.g. http://localhost:4041.
 IOTA_URL = "http://localhost:4041"
-# ToDo: Enter your QuantumLeap url and port, e.g. http://localhost:8668
+# ToDo: Enter your QuantumLeap url and port, e.g. http://localhost:8668.
 QL_URL = "http://localhost:8668"
 
 # ## Main script
 if __name__ == "__main__":
     # ToDo: Create a single client for each service and check the service for
-    #  its version
+    #  its version.
     cbc = ContextBrokerClient(url=CB_URL)
-    print(cbc.get_version())
+    print(f"Context Broker Client: {cbc.get_version()}")
 
     iotac = IoTAClient(url=IOTA_URL)
-    print(iotac.get_version())
+    print(f"IoTA Client: {iotac.get_version()}")
 
     qlc = QuantumLeapClient(url=QL_URL)
-    print(qlc.get_version())
+    print(f"Quantum Leap Client: {qlc.get_version()}")
 
-    # ToDo: Create a configuration object for a multi client
+    # ToDo: Create a configuration object for a multi client.
     config = HttpClientConfig(cb_url=CB_URL, iota_url=IOTA_URL, ql_url=QL_URL)
 
-    # ToDo: Create a multi client check again all services for their version
+    # ToDo: Create a multi client check again all services for their version.
     multic = HttpClient(config=config)
 
-    print(multic.cb.get_version())
-    print(multic.iota.get_version())
-    print(multic.timeseries.get_version())
+    print(f"Multi Client (Context Broker): {multic.cb.get_version()}\n"
+          f"Multi Client (IoTA): {multic.iota.get_version()}\n"
+          f"Multi Client (Quantum Leap): {multic.timeseries.get_version()}")