Skip to content

Commit

Permalink
0.203.0
Browse files Browse the repository at this point in the history
  • Loading branch information
mhogerheijde committed Aug 1, 2024
1 parent 8071729 commit eef50f4
Show file tree
Hide file tree
Showing 14 changed files with 127 additions and 6 deletions.
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# Changelog Hiber API

### 0.203 (2024-07-30)

##### AssignmentService

- Added device to asset assignment in addition to asset to device. They are essentially the same and will be output in the default asset to device format.
- Added `Assignment.to_asset`, `Assign.Request.to_asset` and `Unassign.Request.from_asset` to support the device to asset assignment.

##### CertificateService

- Marked `ca_certificate_name` and `ca_certificate_id` in `Certificate` as optional.

##### MQTTService

- We now enforce the use of `mqtts://` for new MQTT integrations.
- Added `override_url_validation` to `CreateMQTTPublisherRequest` and `UpdateMQTTPublisherRequest` override this if necessary.

### 0.198 (2024-06-25)

##### AssetService
Expand Down
3 changes: 3 additions & 0 deletions assignment.proto
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ message Assignment {
string to_modem = 2;
ModemMessageBodyParserAssignment to_parser = 4;
tag.Tag to_tag = 7;
string to_asset = 11;
}
}

Expand Down Expand Up @@ -191,6 +192,7 @@ message Assign {
oneof to {
modem.ModemSelection to_modems = 5;
tag.TagSelection to_tags = 8;
asset.AssetSelection to_assets = 12;
}

/* The alarm parameters, by alarm identifier, if any, overriding any default values in the alarm(s). */
Expand Down Expand Up @@ -236,6 +238,7 @@ message Unassign {
oneof from {
modem.ModemSelection from_modems = 5;
tag.TagSelection from_tags = 7;
asset.AssetSelection from_assets = 11;
}

/* Time that the assignment ended.
Expand Down
4 changes: 2 additions & 2 deletions certificate.proto
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ message Certificate {
string name = 2;
BytesOrHex certificate = 3;
bool has_private_key = 4;
string ca_certificate_name = 5;
int64 ca_certificate_id = 6;
optional string ca_certificate_name = 5;
optional int64 ca_certificate_id = 6;
}

message CertificateSelection {
Expand Down
21 changes: 21 additions & 0 deletions docs/html/assignment.html
Original file line number Diff line number Diff line change
Expand Up @@ -1308,6 +1308,13 @@ <h3 id="hiber.assign.Assign.Request">Assign.Request</h3>
<td><p> </p></td>
</tr>

<tr>
<td>to_assets</td>
<td><a href="#hiber.asset.AssetSelection">hiber.asset.AssetSelection</a></td>
<td></td>
<td><p> </p></td>
</tr>

<tr>
<td>alarm_parameters</td>
<td><a href="#hiber.assign.Assign.Request.AlarmParametersEntry">Assign.Request.AlarmParametersEntry</a></td>
Expand Down Expand Up @@ -1487,6 +1494,13 @@ <h3 id="hiber.assign.Assignment">Assignment</h3>
<td><p> </p></td>
</tr>

<tr>
<td>to_asset</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>

</tbody>
</table>

Expand Down Expand Up @@ -2702,6 +2716,13 @@ <h3 id="hiber.assign.Unassign.Request">Unassign.Request</h3>
<td><p> </p></td>
</tr>

<tr>
<td>from_assets</td>
<td><a href="#hiber.asset.AssetSelection">hiber.asset.AssetSelection</a></td>
<td></td>
<td><p> </p></td>
</tr>

<tr>
<td>override_time</td>
<td><a href="#hiber.Timestamp">hiber.Timestamp</a></td>
Expand Down
4 changes: 2 additions & 2 deletions docs/html/certificate.html
Original file line number Diff line number Diff line change
Expand Up @@ -496,14 +496,14 @@ <h3 id="hiber.certificate.Certificate">Certificate</h3>
<tr>
<td>ca_certificate_name</td>
<td><a href="#string">string</a></td>
<td></td>
<td>optional</td>
<td><p> </p></td>
</tr>

<tr>
<td>ca_certificate_id</td>
<td><a href="#int64">int64</a></td>
<td></td>
<td>optional</td>
<td><p> </p></td>
</tr>

Expand Down
35 changes: 35 additions & 0 deletions docs/html/event.html
Original file line number Diff line number Diff line change
Expand Up @@ -7844,6 +7844,13 @@ <h3 id="hiber.assign.Assign.Request">Assign.Request</h3>
<td><p> </p></td>
</tr>

<tr>
<td>to_assets</td>
<td><a href="#hiber.asset.AssetSelection">hiber.asset.AssetSelection</a></td>
<td></td>
<td><p> </p></td>
</tr>

<tr>
<td>alarm_parameters</td>
<td><a href="#hiber.assign.Assign.Request.AlarmParametersEntry">Assign.Request.AlarmParametersEntry</a></td>
Expand Down Expand Up @@ -8023,6 +8030,13 @@ <h3 id="hiber.assign.Assignment">Assignment</h3>
<td><p> </p></td>
</tr>

<tr>
<td>to_asset</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>

</tbody>
</table>

Expand Down Expand Up @@ -9238,6 +9252,13 @@ <h3 id="hiber.assign.Unassign.Request">Unassign.Request</h3>
<td><p> </p></td>
</tr>

<tr>
<td>from_assets</td>
<td><a href="#hiber.asset.AssetSelection">hiber.asset.AssetSelection</a></td>
<td></td>
<td><p> </p></td>
</tr>

<tr>
<td>override_time</td>
<td><a href="#hiber.Timestamp">hiber.Timestamp</a></td>
Expand Down Expand Up @@ -13535,6 +13556,13 @@ <h3 id="hiber.integration.mqtt.CreateMQTTPublisherRequest">CreateMQTTPublisherRe
<td><p> </p></td>
</tr>

<tr>
<td>override_url_validation</td>
<td><a href="#bool">bool</a></td>
<td>optional</td>
<td><p>Set this flag to not parse the url or enforce mqtts. </p></td>
</tr>

</tbody>
</table>

Expand Down Expand Up @@ -14475,6 +14503,13 @@ <h3 id="hiber.integration.mqtt.UpdateMQTTPublisherRequest">UpdateMQTTPublisherRe
<td><p><strong>Deprecated.</strong> </p></td>
</tr>

<tr>
<td>override_url_validation</td>
<td><a href="#bool">bool</a></td>
<td>optional</td>
<td><p>Set this flag to not parse the url or enforce mqtts. </p></td>
</tr>

</tbody>
</table>

Expand Down
14 changes: 14 additions & 0 deletions docs/html/integration_mqtt.html
Original file line number Diff line number Diff line change
Expand Up @@ -700,6 +700,13 @@ <h3 id="hiber.integration.mqtt.CreateMQTTPublisherRequest">CreateMQTTPublisherRe
<td><p> </p></td>
</tr>

<tr>
<td>override_url_validation</td>
<td><a href="#bool">bool</a></td>
<td>optional</td>
<td><p>Set this flag to not parse the url or enforce mqtts. </p></td>
</tr>

</tbody>
</table>

Expand Down Expand Up @@ -1640,6 +1647,13 @@ <h3 id="hiber.integration.mqtt.UpdateMQTTPublisherRequest">UpdateMQTTPublisherRe
<td><p><strong>Deprecated.</strong> </p></td>
</tr>

<tr>
<td>override_url_validation</td>
<td><a href="#bool">bool</a></td>
<td>optional</td>
<td><p>Set this flag to not parse the url or enforce mqtts. </p></td>
</tr>

</tbody>
</table>

Expand Down
14 changes: 14 additions & 0 deletions docs/html/publisher.html
Original file line number Diff line number Diff line change
Expand Up @@ -4426,6 +4426,13 @@ <h3 id="hiber.integration.mqtt.CreateMQTTPublisherRequest">CreateMQTTPublisherRe
<td><p> </p></td>
</tr>

<tr>
<td>override_url_validation</td>
<td><a href="#bool">bool</a></td>
<td>optional</td>
<td><p>Set this flag to not parse the url or enforce mqtts. </p></td>
</tr>

</tbody>
</table>

Expand Down Expand Up @@ -5366,6 +5373,13 @@ <h3 id="hiber.integration.mqtt.UpdateMQTTPublisherRequest">UpdateMQTTPublisherRe
<td><p><strong>Deprecated.</strong> </p></td>
</tr>

<tr>
<td>override_url_validation</td>
<td><a href="#bool">bool</a></td>
<td>optional</td>
<td><p>Set this flag to not parse the url or enforce mqtts. </p></td>
</tr>

</tbody>
</table>

Expand Down
3 changes: 3 additions & 0 deletions docs/md/assignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,7 @@ Add assignments.
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **assign**.assign_assets | [ hiber.asset.AssetSelection](#hiberassetassetselection) | |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **to**.to_modems | [ hiber.modem.ModemSelection](#hibermodemmodemselection) | |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **to**.to_tags | [ hiber.tag.TagSelection](#hibertagtagselection) | |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **to**.to_assets | [ hiber.asset.AssetSelection](#hiberassetassetselection) | |
| alarm_parameters | [map Assign.Request.AlarmParametersEntry](#assignrequestalarmparametersentry) | The alarm parameters, by alarm identifier, if any, overriding any default values in the alarm(s). |
| **optional** override_time | [optional hiber.Timestamp](#hibertimestamp) | Time that the assignment should be active. This sets the assignment to start in the past, but would not have effect in the past for assignments like parsers and alarms (they will only be triggered for new messages / values). It would however work for assets having access to device data. This is not allowed to be a value in the future at the moment. |
| **optional** end_time | [optional hiber.Timestamp](#hibertimestamp) | Time that the assignment ended. This marks the assignment as ended at the given moment in the past, but would not have effect in the past for assignments like parsers and alarms (i.e. no alarm events are removed). It would however work for assets having access to device data. This is not allowed to be a value in the future at the moment. |
Expand Down Expand Up @@ -353,6 +354,7 @@ Assignments that are no longer active (end time is in the past) and that no long
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **to**.to_modem | [ string](#string) | |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **to**.to_parser | [ Assignment.ModemMessageBodyParserAssignment](#assignmentmodemmessagebodyparserassignment) | |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **to**.to_tag | [ hiber.tag.Tag](#hibertagtag) | |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **to**.to_asset | [ string](#string) | |

### Assignment.ModemAlarmAssignment

Expand Down Expand Up @@ -663,6 +665,7 @@ Remove a assignment.
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **unassign**.unassign_assets | [ hiber.asset.AssetSelection](#hiberassetassetselection) | |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **from**.from_modems | [ hiber.modem.ModemSelection](#hibermodemmodemselection) | |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **from**.from_tags | [ hiber.tag.TagSelection](#hibertagtagselection) | |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **from**.from_assets | [ hiber.asset.AssetSelection](#hiberassetassetselection) | |
| **optional** override_time | [optional hiber.Timestamp](#hibertimestamp) | Time that the assignment ended. This marks the assignment as ended at the given moment in the past, but would not have effect in the past for assignments like parsers and alarms (i.e. no alarm events are removed). It would however work for assets having access to device data. This is not allowed to be a value in the future at the moment. |

### Unassign.Response
Expand Down
4 changes: 2 additions & 2 deletions docs/md/certificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,8 @@
| name | [ string](#string) | |
| certificate | [ hiber.BytesOrHex](#hiberbytesorhex) | |
| has_private_key | [ bool](#bool) | |
| ca_certificate_name | [ string](#string) | |
| ca_certificate_id | [ int64](#int64) | |
| **optional** ca_certificate_name | [optional string](#string) | |
| **optional** ca_certificate_id | [optional int64](#int64) | |

### CertificateSelection

Expand Down
5 changes: 5 additions & 0 deletions docs/md/event.md
Original file line number Diff line number Diff line change
Expand Up @@ -1777,6 +1777,7 @@ Add assignments.
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **assign**.assign_assets | [ hiber.asset.AssetSelection](#hiberassetassetselection) | |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **to**.to_modems | [ hiber.modem.ModemSelection](#hibermodemmodemselection) | |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **to**.to_tags | [ hiber.tag.TagSelection](#hibertagtagselection) | |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **to**.to_assets | [ hiber.asset.AssetSelection](#hiberassetassetselection) | |
| alarm_parameters | [map hiber.assign.Assign.Request.AlarmParametersEntry](#hiberassignassignrequestalarmparametersentry) | The alarm parameters, by alarm identifier, if any, overriding any default values in the alarm(s). |
| **optional** override_time | [optional hiber.Timestamp](#hibertimestamp) | Time that the assignment should be active. This sets the assignment to start in the past, but would not have effect in the past for assignments like parsers and alarms (they will only be triggered for new messages / values). It would however work for assets having access to device data. This is not allowed to be a value in the future at the moment. |
| **optional** end_time | [optional hiber.Timestamp](#hibertimestamp) | Time that the assignment ended. This marks the assignment as ended at the given moment in the past, but would not have effect in the past for assignments like parsers and alarms (i.e. no alarm events are removed). It would however work for assets having access to device data. This is not allowed to be a value in the future at the moment. |
Expand Down Expand Up @@ -1829,6 +1830,7 @@ Assignments that are no longer active (end time is in the past) and that no long
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **to**.to_modem | [ string](#string) | |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **to**.to_parser | [ hiber.assign.Assignment.ModemMessageBodyParserAssignment](#hiberassignassignmentmodemmessagebodyparserassignment) | |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **to**.to_tag | [ hiber.tag.Tag](#hibertagtag) | |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **to**.to_asset | [ string](#string) | |

### hiber.assign.Assignment.ModemAlarmAssignment

Expand Down Expand Up @@ -2139,6 +2141,7 @@ Remove a assignment.
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **unassign**.unassign_assets | [ hiber.asset.AssetSelection](#hiberassetassetselection) | |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **from**.from_modems | [ hiber.modem.ModemSelection](#hibermodemmodemselection) | |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **from**.from_tags | [ hiber.tag.TagSelection](#hibertagtagselection) | |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **from**.from_assets | [ hiber.asset.AssetSelection](#hiberassetassetselection) | |
| **optional** override_time | [optional hiber.Timestamp](#hibertimestamp) | Time that the assignment ended. This marks the assignment as ended at the given moment in the past, but would not have effect in the past for assignments like parsers and alarms (i.e. no alarm events are removed). It would however work for assets having access to device data. This is not allowed to be a value in the future at the moment. |

### hiber.assign.Unassign.Response
Expand Down Expand Up @@ -2607,6 +2610,7 @@ so not all messages listed here are referenced.)
| **optional** server_ca_certificate_id | [optional int64](#int64) | Server CA certificate to use when connecting to the MQTT server. |
| **optional** disabled | [optional bool](#bool) | Disable the MQTT publisher after creation, so it needs to be enabled before it is active. |
| tags | [repeated int64](#int64) | |
| **optional** override_url_validation | [optional bool](#bool) | Set this flag to not parse the url or enforce mqtts. |

### hiber.integration.mqtt.DeleteMQTTPublisherRequest

Expand Down Expand Up @@ -2818,6 +2822,7 @@ Health configuration for the mqtt integration. Defines how the health is calcula
| **optional** health_warning_period | [optional hiber.Duration](#hiberduration) | Period to consider when determining health from warning events. Warning events cannot be resolved. Set this to 0 to disable warnings based on failure percentage. |
| **optional** health_warning_failure_percentage | [optional uint32](#uint32) | Allowed percentage of call failures. If the failure percentage is higher, within the warning period, the health is switched to WARNING. |
| **optional** deprecated_health_warning_failure_percentage | [optional hiber.UpdateZeroableInt](#hiberupdatezeroableint) | <strong>Deprecated.</strong> |
| **optional** override_url_validation | [optional bool](#bool) | Set this flag to not parse the url or enforce mqtts. |

### hiber.integration.mqtt.UpdateMQTTPublisherTagsRequest

Expand Down
2 changes: 2 additions & 0 deletions docs/md/integration_mqtt.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@
| **optional** server_ca_certificate_id | [optional int64](#int64) | Server CA certificate to use when connecting to the MQTT server. |
| **optional** disabled | [optional bool](#bool) | Disable the MQTT publisher after creation, so it needs to be enabled before it is active. |
| tags | [repeated int64](#int64) | |
| **optional** override_url_validation | [optional bool](#bool) | Set this flag to not parse the url or enforce mqtts. |

### DeleteMQTTPublisherRequest

Expand Down Expand Up @@ -385,6 +386,7 @@ Health configuration for the mqtt integration. Defines how the health is calcula
| **optional** health_warning_period | [optional hiber.Duration](#hiberduration) | Period to consider when determining health from warning events. Warning events cannot be resolved. Set this to 0 to disable warnings based on failure percentage. |
| **optional** health_warning_failure_percentage | [optional uint32](#uint32) | Allowed percentage of call failures. If the failure percentage is higher, within the warning period, the health is switched to WARNING. |
| **optional** deprecated_health_warning_failure_percentage | [optional hiber.UpdateZeroableInt](#hiberupdatezeroableint) | <strong>Deprecated.</strong> |
| **optional** override_url_validation | [optional bool](#bool) | Set this flag to not parse the url or enforce mqtts. |

### UpdateMQTTPublisherTagsRequest

Expand Down
Loading

0 comments on commit eef50f4

Please sign in to comment.