Skip to content

Commit e27cd88

Browse files
committed
docs: change usage
1 parent 80b4724 commit e27cd88

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -136,13 +136,13 @@ module is set to demjson3 per default. The backend can be modified by calling
136136

137137
Since version 2.0.0 this client supports general OData models hosted by FROST servers with active OData plugin.
138138

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:
139+
For this purpose the client provides a command line interface for generating a service 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 the server. It is called like this:
140140
```bash
141-
frost-codegen --url http://localhost:8080/FROST-Server --out my_service_configuration
141+
frost-codegen --url http://localhost:8080/FROST-Server --out my_service_module
142142
```
143143
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.
144144

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:
145+
In order to use the generated module, it needs to be imported in the source code. The corresponding service needs to be created with parameter `model` instead of `url`. In case the FROST server in use contains the SensorThings data model, the following two programs are equivalent:
146146

147147
Variant I:
148148
```
@@ -164,11 +164,10 @@ service.create(thing)
164164
Variant II:
165165
```
166166
import frost_sta_client as fsc
167-
import my_service_configuration
167+
import my_service_module as mdl
168168
from geojson import Point
169169
170-
service = fsc.SensorThingsService(config=my_service_configuration)
171-
mdl = service.model
170+
service = fsc.SensorThingsService(model=mdl)
172171
173172
point = Point((-115.81, 37.24))
174173
location = mdl.Location(name="here", description="and there", location=point, encoding_type='application/geo+json')

0 commit comments

Comments
 (0)