search

stefan-kaestle / openhab2-addons

Add-ons for openHAB 2.x
Eclipse Public License 2.0
16 stars 1 forks source link

Migrate to API 2.1 #78

Closed sebastianharder closed 3 years ago

sebastianharder commented 3 years ago

Support for API 1.0 is dropped, see BoschSmartHome/bosch-shc-api-docs#46

Migration to 2.1 is required.

GerdZanker commented 3 years ago

Thanks a lot for this vital information @sebastianharder.

coeing commented 3 years ago

@sebastianharder Is the official API documentation at https://apidocs.bosch-smarthome.com/local/ already up-to-date? I/We use that page a lot to get the data structures right :)

GerdZanker commented 3 years ago

Here is the diff between the two available releases 0.5 and 2.1. An API Version 1.0 is not tagged in github.

coeing commented 3 years ago

@GerdZanker Thanks :) It does not look too different, so we should be fine.

coeing commented 3 years ago

@GerdZanker Thanks :) It does not look too different, so we should be fine.

sebastianharder commented 3 years ago

@coeing https://apidocs.bosch-smarthome.com/local/ is not yet up-to-date. We are working on it.

For now, everything should still work if you replace the version in the "api-version" header with "2.1". The version jump from 1.x to 2.x was only due to internal APIs that are not part of the public API.

However, you might want to consider to support the profiles for the intrusion detection system, which are only available in 2.1.

coeing commented 3 years ago

@sebastianharder Thanks for the clarification. About the intrusion detection: We will support more devices over time, let's see what we get into v2 :) We will first support the devices we have at home ourselves, I have no intrusion detection system myself, so it is hard to test the correct implementation.

GerdZanker commented 3 years ago

This should be an easy change, because there is one central createRequest function.

sebastianharder commented 3 years ago

@coeing https://apidocs.bosch-smarthome.com/local/ is now up-to-date.

Cheers!

coeing commented 3 years ago

@coeing https://apidocs.bosch-smarthome.com/local/ is now up-to-date.

Cheers!

Thanks @sebastianharder ! That site is my favorite one for information about your API, so it's nice that it is up-to-date :)