You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-20Lines changed: 9 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -136,24 +136,13 @@ module is set to demjson3 per default. The backend can be modified by calling
136
136
137
137
Since version 2.0.0 this client supports general OData models hosted by FROST servers with active OData plugin.
138
138
139
-
For this purpose the client provides a command line interface for generating a python module containing the URL of the FROST server in use as well as source code for the Python classes corresponding to the data model contained in it. It is called like this:
139
+
For this purpose the client provides a command line interface for generating a service configuration module containing the URL of the FROST server in use as well as source code for the Python classes corresponding to the data model contained in it. It is called like this:
The generator tries the OData 4.01 endpoint of the FROST server in use first and falls back to the OData 4.0 if the other one is not available.
143
+
The generator tries the OData 4.01 endpoint of the FROST server in use first and falls back to the OData 4.0 if the other one is not available. If even the latter is not available the generator fails.
144
144
145
-
In order to use the custom data model it needs to be imported in the source code. The corresponding service needs to be created with paramter `model` instead of `url`. In fact, the following two programs are equivalent:
146
-
```
147
-
import frost_sta_client as fsc
148
-
import .my_datamodel as my_model
149
-
150
-
service = fsc.SensorThingsService(model=my_model)
151
-
152
-
my_entity = my_model.MyEntityClass(...)
153
-
service.create(my_entity)
154
-
```
155
-
156
-
For backward compatibility, a client for a FROST server containing the SensorThings data model can be used as in previous versions of this client. In fact, the following two programs are equivalent in this case:
145
+
In order to use the generated service configuration module, it needs to be imported in the source code. The corresponding service needs to be created with paramter `config` instead of `url`. In case the FROST server in use contains the SensorThings data model, the following two programs are equivalent:
157
146
158
147
Variant I:
159
148
```
@@ -175,15 +164,15 @@ service.create(thing)
175
164
Variant II:
176
165
```
177
166
import frost_sta_client as fsc
178
-
import .my_datamodel as my_model
167
+
import my_service_configuration
179
168
from geojson import Point
180
169
181
-
service = fsc.SensorThingsService(model=my_model)
182
-
m = service.model
170
+
service = fsc.SensorThingsService(config=my_service_configuration)
0 commit comments