fix: ngsi v2 tutorials are deprecated (#255)

filip/models/ngsi_v2/iot.py

@@ -219,7 +219,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_solution.py

@@ -31,13 +31,12 @@
 # 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"
+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
@@ -52,7 +51,6 @@
 T_SIM_END = 24 * 60 * 60  # simulation end time in seconds
 COM_STEP = 60 * 60 * 1  # 60 min communication step in seconds
 
-
 # ## Main script
 if __name__ == '__main__':
     # instantiate simulation model
@@ -68,6 +66,7 @@
     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
@@ -83,7 +82,6 @@ def on_message(client, userdata, msg):
         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
@@ -118,7 +116,7 @@ def on_message(client, userdata, msg):
 
         # simulation step for next loop
         sim_model.do_step(int(t_sim + COM_STEP))
-        time.sleep(1)
+        time.sleep(0.1)
 
     # 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_solution.py

@@ -35,20 +35,20 @@
     # 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 = 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
     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
     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()}")

tutorials/ngsi_v2/e3_context_entities/e3_context_entities_solution.py

@@ -49,7 +49,7 @@
 
 # FIWARE-Service
 SERVICE = 'filip_tutorial'
-# FIWARE-Servicepath
+# FIWARE-Service path
 # ToDo: Change the name of your service-path to something unique. If you run
 #  on a shared instance this very important in order to avoid user
 #  collisions. You will use this service path through the whole tutorial.
@@ -114,7 +114,7 @@
                               entity_type=building.type)
 
     # print your `building model` as json
-    print(f"This is your building model: \n {building.json(indent=2)} \n")
+    print(f"This is your building model: \n {building.model_dump_json(indent=2)} \n")
 
     # ToDo: create a `opening hours` property and add it to the building object
     #  in the context broker. Do not update the whole entity! In real
@@ -136,7 +136,7 @@
     hours = cbc.get_attribute_value(entity_id=building.id,
                                     entity_type=building.type,
                                     attr_name=opening_hours.name)
-    print(f"Your opening hours: {hours} \n" )
+    print(f"Your opening hours: {hours} \n")
 
     # ToDo: modify the `opening hours` of the building
     cbc.update_attribute_value(entity_id=building.id,
@@ -152,7 +152,7 @@
                               entity_type=building.type)
 
     # print your building
-    print(f"Your updated building model: \n {building.json(indent=2)}")
+    print(f"Your updated building model: \n {building.model_dump_json(indent=2)}")
 
     # ToDo: Create an entity of thermal zone and add a description property
     #  to it
@@ -174,15 +174,15 @@
 
     # print all relationships of your thermal zone
     for relationship in thermal_zone.get_relationships():
-        print(f"Relationship properties of your thermal zone mdoel: \n "
-              f"{relationship.json(indent=2)} \n")
+        print(f"Relationship properties of your thermal zone model: \n "
+              f"{relationship.model_dump_json(indent=2)} \n")
 
     # ToDo: Post your thermal zone model to the context broker
     cbc.post_entity(entity=thermal_zone)
     thermal_zone = cbc.get_entity(entity_id=thermal_zone.id,
                                   entity_type=thermal_zone.type)
 
-    # ToDo: Create and a property that references your thermal zone. Use the
+    # ToDo: Create and add a property that references your thermal zone. Use the
     #  `Relationship` for type and `hasZone` for its name. Make sure that
     #  your local model and the server model are in sync afterwards.
     ref_zone = NamedContextAttribute(name="hasZone",
@@ -203,7 +203,7 @@
     query = QueryString(qs=("refBuilding", "==", building.id))
     for entity in cbc.get_entity_list(q=query):
         print(f"All entities referencing the building: "
-              f"\n {entity.json(indent=2)}\n")
+              f"\n {entity.model_dump_json(indent=2)}\n")
 
     # ToDo: create a filter request that retrieves all entities from the
     #   server`that have `hasZone' attribute that references your thermal zone
@@ -214,14 +214,14 @@
     query = QueryString(qs=("hasZone", "==", thermal_zone.id))
     for entity in cbc.get_entity_list(q=query):
         print(f"All entities referencing the thermal zone: "
-              f"\n {entity.json(indent=2)} \n")
+              f"\n {entity.model_dump_json(indent=2)} \n")
 
     # write entities to file and clear server state
     assert WRITE_ENTITIES_FILEPATH.suffix == '.json', \
         f"Wrong file extension! {WRITE_ENTITIES_FILEPATH.suffix}"
     WRITE_ENTITIES_FILEPATH.touch(exist_ok=True)
     with WRITE_ENTITIES_FILEPATH.open('w', encoding='utf-8') as f:
-        entities = [item.dict() for item in cbc.get_entity_list()]
+        entities = [item.model_dump() for item in cbc.get_entity_list()]
         json.dump(entities, f, ensure_ascii=False, indent=2)
 
     clear_context_broker(url=CB_URL, fiware_header=fiware_header)