222 integration of ngsi ld endpoints

CHANGELOG.md

@@ -1,6 +1,14 @@
+#### v0.3.1
+- add tutorial for protected endpoint with bearer authentication ([#208](https://github.com/RWTH-EBC/FiLiP/issues/208))
+- update pandas version to `~=2.1.4` for `python>=3.9` ([#231](https://github.com/RWTH-EBC/FiLiP/pull/231))
+- fix: wrong msg in iotac post device ([#214](https://github.com/RWTH-EBC/FiLiP/pull/214))
+
 #### v0.3.0
-- fixed inconsistency of `entity_type` as required argument ([#188](https://github.com/RWTH-EBC/FiLiP/issues/188))
-- BREAKING CHANGE: Migration of pydantic v1 to v2 ([#199](https://github.com/RWTH-EBC/FiLiP/issues/199))
+- fix: bug in typePattern validation @richardmarston ([#180](https://github.com/RWTH-EBC/FiLiP/pull/180))
+- add: add messages to all KeyErrors @FWuellhorst ([#192](https://github.com/RWTH-EBC/FiLiP/pull/192))
+- add: optional module `semantics` in setup tool @djs0109
+- fix: get() method of Units dose not work properly by @djs0109 ([#193](https://github.com/RWTH-EBC/FiLiP/pull/193))
+- BREAKING CHANGE: Migration of pydantic v1 to v2 @djs0109 ([#199](https://github.com/RWTH-EBC/FiLiP/issues/199))
 
 #### v0.2.5
 - fixed service group edition not working ([#170](https://github.com/RWTH-EBC/FiLiP/issues/170))

README.md

@@ -83,6 +83,13 @@ If you want to benefit from the latest changes, use the following command
 pip install -U git+git://github.com/RWTH-EBC/filip
 ```
 
+#### Install semantics module (optional)
+
+If you want to use the optional [semantics module](filip/semantics), use the following command (This will install the libraries that only required for the semantics module):
+````
+pip install -U filip[semantics]
+````
+
 ### Introduction to FIWARE
 
 The following section introduces FIWARE. If you are already familiar with 
@@ -212,34 +219,38 @@ how you can contribute to this project.
 
 ## Authors
 
-* [Thomas Storek](https://www.ebc.eonerc.rwth-aachen.de/cms/E-ON-ERC-EBC/Das-Institut/Mitarbeiter/Team2/~lhda/Thomas-Storek/?lidx=1) (corresponding)
+* [Thomas Storek](https://github.com/tstorek) 
+* [Junsong Du](https://www.ebc.eonerc.rwth-aachen.de/cms/E-ON-ERC-EBC/Das-Institut/Mitarbeiter/Digitale-Energie-Quartiere/~trcib/Du-Junsong/lidx/1/) (corresponding)
 * [Saira Bano](https://www.ebc.eonerc.rwth-aachen.de/cms/E-ON-ERC-EBC/Das-Institut/Mitarbeiter/Systemadministration/~ohhca/Bano-Saira/)
-* [Daniel Nikolay](https://www.ebc.eonerc.rwth-aachen.de/cms/E-ON-ERC-EBC/Das-Institut/Mitarbeiter/Systemadministration/~qcqxq/Nikolay-Daniel/)
+* [Sebastian Blechmann](https://www.ebc.eonerc.rwth-aachen.de/cms/E-ON-ERC-EBC/Das-Institut/Mitarbeiter/Team2/~carjd/Blechmann-Sebastian/)
 
 ## Alumni
 
 * Jeff Reding
 * Felix Rehmann
+* Daniel Nikolay
 
 ## References
 
 We presented or applied the library in the following publications:
 
+- S. Blechmann, I. Sowa, M. H. Schraven, R. Streblow, D. Müller & A. Monti. Open source platform application for smart building and smart grid controls. Automation in Construction 145 (2023), 104622. ISSN: 0926-5805. https://doi.org/10.1016/j.autcon.2022.104622        
+
 - Haghgoo, M., Dognini, A., Storek, T., Plamanescu, R, Rahe, U., 
   Gheorghe, S, Albu, M., Monti, A., Müller, D. (2021) A cloud-based service-oriented architecture to unlock smart energy services
-  https://www.doi.org/10.1186/s42162-021-00143-x
+  https://www.doi.org/10.1186/s42162-021-00143-x      
 
 - Baranski, M., Storek, T. P. B., Kümpel, A., Blechmann, S., Streblow, R., 
 Müller, D. et al.,
 (2020). National 5G Energy Hub : Application of the Open-Source Cloud Platform 
 FIWARE for Future Energy Management Systems. 
-https://doi.org/10.18154/RWTH-2020-07876
+https://doi.org/10.18154/RWTH-2020-07876      
 
 - T. Storek, J. Lohmöller, A. Kümpel, M. Baranski & D. Müller (2019). 
 Application of the open-source cloud platform FIWARE for future building 
 energy management systems. 
 Journal of Physics: 
-Conference Series, 1343, 12063. https://doi.org/10.1088/1742-6596/1343/1/012063
+Conference Series, 1343, 12063. https://doi.org/10.1088/1742-6596/1343/1/012063     
 
 ## License
 
@@ -249,7 +260,7 @@ This project is licensed under the BSD License - see the [LICENSE](LICENSE) file
 
 <a href="https://www.ebc.eonerc.rwth-aachen.de/"> <img alt="EBC" src="https://www.ebc.eonerc.rwth-aachen.de/global/show_picture.asp?id=aaaaaaaaaakevlz" height="100"> </a>
 
-2021-2022, RWTH Aachen University, E.ON Energy Research Center, Institute for Energy 
+2021-2024, RWTH Aachen University, E.ON Energy Research Center, Institute for Energy 
 Efficient Buildings and Indoor Climate
 
 [Institute for Energy Efficient Buildings and Indoor Climate (EBC)](https://www.ebc.eonerc.rwth-aachen.de)  

examples/basics/e02_baerer_token.py

@@ -0,0 +1,31 @@
+"""
+# Examples for initializing a contextbroker client with authorization via bearer
+token.
+- The authorization key is provided via the FiwareHeaderSecure class.
+- The parameters should be provided via environment variables or a .env file.
+"""
+
+from filip.models.base import FiwareHeaderSecure
+from filip.clients.ngsi_v2 import ContextBrokerClient
+
+# ## Parameters
+# Host address of Context Broker
+CB_URL = "https://localhost:1026"
+# FIWARE-Service
+fiware_service = 'filip'
+# FIWARE-Servicepath
+fiware_service_path = '/example'
+# FIWARE-Bearer token
+# TODO it has to be replaced with the token of your protected endpoint
+fiware_baerer_token = 'BAERER_TOKEN'
+
+if __name__ == '__main__':
+    fiware_header = FiwareHeaderSecure(service=fiware_service,
+                                       service_path=fiware_service_path,
+                                       authorization=f"""Bearer {
+                                       fiware_baerer_token}""")
+    cb_client = ContextBrokerClient(url=CB_URL,
+                                    fiware_header=fiware_header)
+    # query entities from protected orion endpoint
+    entity_list = cb_client.get_entity_list()
+    print(entity_list)

filip/__init__.py

@@ -4,4 +4,4 @@
 from filip.config import settings
 from filip.clients.ngsi_v2 import HttpClient
 
-__version__ = '0.2.4'
+__version__ = '0.3.0'