version 1.0.0-rc.16

python-client/README.md

@@ -1,10 +1,13 @@
-# openapi-client
-Jungfraujoch Broker Web API
+# jfjoch-client
+API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland).
+Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU.
+Jungfraujoch uses FPGA boards to acquire data at high data rates.
+
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 1.0.0-rc.15
-- Package version: 1.0.0
+- API version: 1.0.0-rc.16
+- Package version: 1.0.0-rc.16
 - Generator version: 7.8.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
@@ -24,7 +27,7 @@ pip install git+https://git.psi.ch/jungfraujoch/jungfraujoch.git
 
 Then import the package:
 ```python
-import openapi_client
+import jfjoch_client
 ```
 
 ### Setuptools
@@ -38,7 +41,7 @@ python setup.py install --user
 
 Then import the package:
 ```python
-import openapi_client
+import jfjoch_client
 ```
 
 ### Tests
@@ -51,22 +54,22 @@ Please follow the [installation procedure](#installation--usage) and then run th
 
 ```python
 
-import openapi_client
-from openapi_client.rest import ApiException
+import jfjoch_client
+from jfjoch_client.rest import ApiException
 from pprint import pprint
 
-# Defining the host is optional and defaults to http://localhost
+# Defining the host is optional and defaults to http://localhost:5232
 # See configuration.py for a list of all supported configuration parameters.
-configuration = openapi_client.Configuration(
-    host = "http://localhost"
+configuration = jfjoch_client.Configuration(
+    host = "http://localhost:5232"
 )
 
 
 
 # Enter a context with an instance of the API client
-with openapi_client.ApiClient(configuration) as api_client:
+with jfjoch_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
-    api_instance = openapi_client.DefaultApi(api_client)
+    api_instance = jfjoch_client.DefaultApi(api_client)
 
     try:
         # Cancel running data collection
@@ -78,7 +81,7 @@ with openapi_client.ApiClient(configuration) as api_client:
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *http://localhost:5232*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
@@ -151,9 +154,12 @@ Class | Method | HTTP request | Description
  - [DetectorListDetectorsInner](docs/DetectorListDetectorsInner.md)
  - [DetectorModule](docs/DetectorModule.md)
  - [DetectorModuleDirection](docs/DetectorModuleDirection.md)
+ - [DetectorPowerState](docs/DetectorPowerState.md)
  - [DetectorSelection](docs/DetectorSelection.md)
  - [DetectorSettings](docs/DetectorSettings.md)
+ - [DetectorState](docs/DetectorState.md)
  - [DetectorStatus](docs/DetectorStatus.md)
+ - [DetectorTiming](docs/DetectorTiming.md)
  - [DetectorType](docs/DetectorType.md)
  - [ErrorMessage](docs/ErrorMessage.md)
  - [FpgaStatusInner](docs/FpgaStatusInner.md)