forked from RWTH-EBC/FiLiP
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathe07_ngsi_v2_iota_basics.py
184 lines (166 loc) · 6.66 KB
/
e07_ngsi_v2_iota_basics.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
"""
# # Examples for working with IoT Devices
"""
# ## Import packages
import logging
import json
from filip.clients.ngsi_v2 import IoTAClient
from filip.models.base import FiwareHeader, DataType
from filip.models.ngsi_v2.iot import Device, ServiceGroup, TransportProtocol, \
StaticDeviceAttribute, DeviceAttribute, LazyDeviceAttribute, DeviceCommand
from uuid import uuid4
from filip.config import settings
# ## Parameters
#
# To run this example you need a working Fiware v2 setup with a context-broker
# and an iota-broker. Here you can set the addresses:
#
# Host address of Context Broker
CB_URL = settings.CB_URL
# Host address of IoT-Agent
IOTA_URL = settings.IOTA_URL
# Here you can also change FIWARE service and service path.
# FIWARE-Service
SERVICE = 'filip'
# FIWARE-Service path
SERVICE_PATH = '/example'
# Setting up logging
logging.basicConfig(
level='INFO',
format='%(asctime)s %(name)s %(levelname)s: %(message)s',
datefmt='%d-%m-%Y %H:%M:%S')
logger = logging.getLogger(__name__)
if __name__ == "__main__":
# # 1 Setup IoTAClient
#
# First a client is initialised that provides access to our
# Fiware-server space.
#
# For more details about this step see e01_http_clients.py.
fiware_header = FiwareHeader(service=SERVICE,
service_path=SERVICE_PATH)
iota_client = IoTAClient(url=IOTA_URL,
fiware_header=fiware_header)
print(f"IoTA: {json.dumps(iota_client.get_version(), indent=2)}"
f" located at the url: {iota_client.base_url}")
# # 2 Device Model
#
# ## 2.1 Create a device
#
# A device can be created in two ways.
# For all information about the needed device attributes, please
# reference the DeviceModel directly.
#
# When a device is posted to Fiware, Fiware will automatically create a
# ContextEntity that symbolises the current device state. Through the
# ContextBrokerClient and the entity, the state of the device can be seen
# and manipulated.
#
# Dictionary:
example_device_dict = {"device_id": "urn:ngsi-ld:sensor:001",
"service": SERVICE,
"service_path": SERVICE_PATH,
"entity_name": "sensor1",
"entity_type": "Sensor",
"timezone": 'Europe/Berlin',
"timestamp": True,
"apikey": "1234",
"protocol": "IoTA-UL",
"transport": "MQTT",
"lazy": [],
"commands": [],
"attributes": [],
"static_attributes": [],
"internal_attributes": [],
"explicitAttrs": False,
"ngsiVersion": "v2"}
device1 = Device(**example_device_dict)
# Direct Parameters:
device2 = Device(device_id="urn:ngsi-ld:sensor:002",
service=SERVICE,
service_path=SERVICE_PATH,
entity_name="sensor2",
entity_type="Sensor",
transport=TransportProtocol.HTTP,
endpoint="http://orion:1026") # URL for IoTAgent to reach Orion
# ## 2.2 Device Attributes
#
# You can add attributes to a device, and they will automatically be
# mirrored to the related context entity.
# Each attribute needs a unique name.
#
# ### 2.2.1 StaticDeviceAttribute
#
# These attributes represent static information (such as names) and are
# mirrored 1:1
device2.add_attribute(StaticDeviceAttribute(name="address",
type=DataType.TEXT,
value="Lichtenhof 3"))
# ### 2.2.2 DeviceAttribute
#
# These attributes represent live information of the device.
# The value can be read by accessing the mirrored attribute in the
# context entity.
# It is differentiated between two kinds:
#
# DeviceAttributes, always keep the value in the context entity up-to-date
# (polling)
device2.add_attribute(DeviceAttribute(name="temperature",
object_id="t"))
# LazyDeviceAttributes, only update the value in the entity if it is
# accessed (event based)
device2.add_attribute(LazyDeviceAttribute(name="temperature"))
# ### 2.2.3 Commands
#
# Commands can be executed to let the device execute some action
device2.add_attribute(DeviceCommand(name="on"))
# In the context entity three attributes are added for a command:
# - Command (name): used to execute
# - Status (name_status): used to inform about execution status
# - Info/Result (name_info): used to inform about the final result
# # 3 Interact with Fiware
#
# ## 3.1 Upload a new Device
print(f"Payload that will be sent to the IoT-Agent:\n "
f"{device2.model_dump_json(indent=2)}")
iota_client.post_device(device=device2, update=True)
#
# ## 3.2 Load a specific device as model
my_device = iota_client.get_device(device_id=device2.device_id)
#
# ## 3.3 Load multiple devices
my_devices = iota_client.get_device_list()
#
# ## 3.4 Update a device
#
# After changes were made to the device, the simplest way to transfer
# them to Fiware is through patch_device method:
iota_client.patch_device(my_device)
#
# ## 3.5 Delete a device
iota_client.delete_device(device_id=device2.device_id)
# # 4 Service Groups
#
# For some services, there will be no need to provision individual devices,
# but it will make more sense to provision different service groups,
# each of one mapped to a different type of entity in the context broker
# https://iotagent-node-lib.readthedocs.io/en/latest/api/index.html#service-group-api
# ## 4.1. Create a service group
service_group1 = ServiceGroup(entity_type='Thing',
resource='/iot/json',
apikey=str(uuid4()))
iota_client.post_groups(service_groups=[service_group1])
# ## 4.2 Access a service group
#
# All groups:
retrieved_groups = iota_client.get_group_list()
# a specific group
my_group = iota_client.get_group(resource='/iot/json',
apikey=service_group1.apikey)
# ## 4.3 Delete a service group
iota_client.delete_group(resource='/iot/json',
apikey=service_group1.apikey)
# # 5 Clean up (Optional)
#
# Close client
iota_client.close()