Sailor

Release notes
- **New feature: Create Alerts.**
Creating alerts in Predictive Asset Insights (PAI) / Assetcentral (AC) is now supported. Alerts support the use case of automated machine created events for an equipment.

A single alert can be created using the `sailor.pai.create_alert` function.
The create_alert function uses the same syntax and semantics as the create_notification function. See the tutorial on ["Writing Master Data"](https://sap.github.io/project-sailor/tutorial.html#how-to-write-master-data).
Specifying and reading custom fields on alerts is supported, too. Please refer to [create_alert](https://sap.github.io/project-sailor/apidoc/sailor.pai.html#sailor.pai.create_alert) for more information.

You need PAI and AC credentials to use this feature. Please check the documentation for a [configuration](https://sap.github.io/project-sailor/introduction.html#configuration) example.
- Bugfix: find_alerts: numeric and timestamp fields could not be queried correctly
- Removed deprecated features as announced in warnings


**List of closed pull-requests since last release**
[68](https://github.com/SAP/project-sailor/pull/68): Introduce new MasterDataEntity and MasterDataField as new base classes.
[70](https://github.com/SAP/project-sailor/pull/70): simplify patching in iot tests
[71](https://github.com/SAP/project-sailor/pull/71): Configure In Solidarity app to ignore "masterdata"
[72](https://github.com/SAP/project-sailor/pull/72): Docs: add inherited functions of classes
[73](https://github.com/SAP/project-sailor/pull/73): Introduce query transformer to support TS offset for PAI Alert

Release notes
- **New feature: Read Alerts.**
Reading alerts from Predictive Asset Insights (PAI) is now possible using function [find_alerts](https://sap.github.io/project-sailor/apidoc/sailor.pai.html#sailor.pai.find_alerts).

You need a PAI account to use this feature. Please check the documentation for a [configuration](https://sap.github.io/project-sailor/introduction.html#configuration) example.
- IoT extension API endpoints are now determined dynamically.

If you want to use the (still BETA) upload feature for timeseries data, you now need to specify the `extension_url` parameter in the [configuration](https://sap.github.io/project-sailor/introduction.html#configuration).
- Timeseries is now retrieved without model information.

Equipment is uniquely identified by its ID, hence including model information in the TimeseriesDataset is redundant. In order to reduce memory usage timeseries data is now stored without model information. Using TimeseriesDataset.as_df still returns model information by default, but if you would like to reduce the memory used by the returned dataframe you can pass `include_model=False`.


**List of closed pull-requests since last release**
[45](https://github.com/SAP/project-sailor/pull/45): Read Alerts from Predictive Asset Insights (PAI)
[49](https://github.com/SAP/project-sailor/pull/49): test with SonarCloud and github actions
[50](https://github.com/SAP/project-sailor/pull/50): Code quality: add SonarCloud to validation jobs
[51](https://github.com/SAP/project-sailor/pull/51): new field objects for Equipment + adapt is_exposed (private fields)
[52](https://github.com/SAP/project-sailor/pull/52): set python version to 3 in sonar config
[53](https://github.com/SAP/project-sailor/pull/53): new field objects for FailureMode
[54](https://github.com/SAP/project-sailor/pull/54): new field objects for Group
[55](https://github.com/SAP/project-sailor/pull/55): new field objects for Indicator
[56](https://github.com/SAP/project-sailor/pull/56): new field objects for Location
[57](https://github.com/SAP/project-sailor/pull/57): new field objects for Model
[58](https://github.com/SAP/project-sailor/pull/58): new field objects for System and Workorder
[59](https://github.com/SAP/project-sailor/pull/59): adapt the endpoint for the funky non-abstract abstract SAP IoT API
[60](https://github.com/SAP/project-sailor/pull/60): use is_exposed in tests for public attributes
[61](https://github.com/SAP/project-sailor/pull/61): migrate Alert to use new field structure
[62](https://github.com/SAP/project-sailor/pull/62): small fix to Notification.plot_overview
[63](https://github.com/SAP/project-sailor/pull/63): remove unused functions
[64](https://github.com/SAP/project-sailor/pull/64): remove legacy mapping
[65](https://github.com/SAP/project-sailor/pull/65): improved progress updates for reading bulk timeseries data
[66](https://github.com/SAP/project-sailor/pull/66): Refactor/timeseries without modelid
[67](https://github.com/SAP/project-sailor/pull/67): implement dynamic determination of extension endpoints
[69](https://github.com/SAP/project-sailor/pull/69): fix too many prints...

**Changes**
[1.4.0...1.5.0](https://github.com/sap/project-sailor/compare/1.4.0...1.5.0)

Release notes
- **New BETA feature: Timeseries write support.**
You can now write timeseries data to SAP IoT. This feature is considered BETA.

We will attempt to keep all interfaces stable but do not give guarantees yet. Feedback for this feature is particularly appreciated.
Please check out the [API documentation](https://sap.github.io/project-sailor/apidoc/sailor.sap_iot.write.html) for more information.
- **New feature: Support for creating and editing Notifications in Assetcentral.**
You can now create or edit notification objects.
Please check out our new tutorial section on [Writing Master Data](https://sap.github.io/project-sailor/tutorial.html#how-to-write-master-data).
- **Retrieve indicator data for every indicator in a System or SystemSet.**
``get_indicator_data`` now returns indicator data for all pieces of equipment belonging to a system (instead of only first-level pieces of equipment).



**List of closed pull-requests since last release**
[27](https://github.com/SAP/project-sailor/pull/27): Assetcentral: create and edit Notification objects
[38](https://github.com/SAP/project-sailor/pull/38): Feature/system hierarchies2
[47](https://github.com/SAP/project-sailor/pull/47): Timeseries write support, first implementation, now with tests
[48](https://github.com/SAP/project-sailor/pull/48): Update documentation (tutorial and related pages)

**List of closed issues since last release**
[41](https://github.com/SAP/project-sailor/issues/41): Support writing time-series data to SAP IoT

**Changes**
[1.3.0...1.4.0](https://github.com/sap/project-sailor/compare/1.3.0...1.4.0)

Release notes
-------------
- **New feature: Support for Assetcentral Group objects.**
Implementation of ``Group`` objects, supporting equipment, location and model elements in groups
- OAuth session mangament improved, resulting in less remote calls and reuse of http connections
- Filtering options for ``TimeseriesDataset`` improved: now supports filtering by ``EquipmentSet`` and ``IndicatorSet``
- Small bugfixes


**List of closed pull-requests since last release**
[25](https://github.com/SAP/project-sailor/pull/25): Add "Sailor" logo to documentation
[26](https://github.com/SAP/project-sailor/pull/26): README: fix reuse link / add logo
[28](https://github.com/SAP/project-sailor/pull/28): Bump urllib3 from 1.26.4 to 1.26.5 in /.ci/docs

Release notes
=============
- **Feature: Interpolate TimeseriesDataset**
A resulting ``TimeseriesDataset`` will have equidistant points in the half-open interval between the start and end point of the dataset.
Please check the API docs for more information.
- Improvement: OAuth client re-uses tokens and connections. Improves speed of consecutive remote requests.


**List of closed pull-requests since last release**
[10](https://github.com/SAP/project-sailor/pull/10): Prepare support of time series data for system hierarchies
[21](https://github.com/SAP/project-sailor/pull/21): Feature/equidistant timeseries
[23](https://github.com/SAP/project-sailor/pull/23): Improve client handling and refactor OAuth client
[24](https://github.com/SAP/project-sailor/pull/24): Refactor OAuthFlow: offer full functionality for requests

**Changes**
[1.1.0...1.2.0](https://github.com/sap/project-sailor/compare/1.1.0...1.2.0)

Release notes
---------------
- New feature: **Time-Aggregate TimeseriesDatasets**. This allows for aggregating TimeseriesDatasets based on supported aggregation intervals. Kindly check the API documentation to find more information.
- Python 3.9 is now supported.
- Major version bump of PyJWT dependency to 2.0.1.
- Small bugfixes.


**List of closed pull-requests since last release**
[5](https://github.com/SAP/project-sailor/pull/5): Add pre-push githook to prevent accidental pushes to main
[6](https://github.com/SAP/project-sailor/pull/6): Update codeql-analysis.yml
[7](https://github.com/SAP/project-sailor/pull/7): Implement AggregatedIndicator class
[8](https://github.com/SAP/project-sailor/pull/8): Improve API documentation navigation and function listing
[9](https://github.com/SAP/project-sailor/pull/9): Time-Aggregate TimeseriesDatasets
[11](https://github.com/SAP/project-sailor/pull/11): fix short scope extensions for IoT
[12](https://github.com/SAP/project-sailor/pull/12): Add more tests for sailor.assetcentral.utils / small fixes