Skip to content

Commit

Permalink
0.147.0
Browse files Browse the repository at this point in the history
  • Loading branch information
mhogerheijde committed Apr 11, 2023
1 parent 80c4860 commit 05e2660
Show file tree
Hide file tree
Showing 9 changed files with 44 additions and 44 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog Hiber API

### 0.147 (2023-04-10)



### 0.146 (2023-04-03)


Expand Down
9 changes: 4 additions & 5 deletions device.proto
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,9 @@ message Device {
/* Other identifiers for this devices. Could include data like its MAC-address or otherwise unique identifier. */
repeated string identifiers = 1;

/* The device directly downstream from this device.
* Usually a gateway of some sorts. This device sends its data directly to its parent.
* The parent will relay the data to our systems. */
optional string parent = 2;
/* The gateway directly upstream from this device (in the direction of Mission Control).
* This device sends its data directly to its gateway, which in turn relays it to Mission Control. */
optional string gateway = 2;

// /* The devices that are directly upstream form this device if any.
// * The upstream devices use this device to relay messages for them. */
Expand All @@ -92,7 +91,7 @@ message DeviceSelection {
Filter.ModemIdentifiers identifiers = 3;
Filter.HealthLevels health_level = 4;
ModemFilter.Lifecycles lifecycles = 5;
Filter.Modems with_parents = 6;
Filter.Modems with_gateways = 6;
Filter.Properties peripherals = 7;

hiber.tag.TagSelection filter_by_tags = 8;
Expand Down
16 changes: 8 additions & 8 deletions device_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -139,22 +139,22 @@ message ListDevice {
/* Filter devices by location. */
LocationSelection location_selection = 5;

/* Set this to true to populate the parents field in the response.
* This will be populated with missing parents (e.g. gateways) for the the devices on this page.
* Any parent that is on the current page is not included in this list to avoid duplicate data.
/* Set this to true to populate the gateways field in the response.
* This will be populated with missing gateways for the the devices on this page.
* Any gateway that is on the current page is not included in this list to avoid duplicate data.
*/
bool include_missing_parents = 6;
bool include_missing_gateways = 6;
}
message Response {
repeated Device devices = 1;
ListDevice.Request request = 2;
Pagination.Result pagination = 3;
repeated Sort sorted_by = 4;

/* This will be populated with missing parents (e.g. gateways) for the the devices on this page.
* Any parent that is on the current page is not included in this list to avoid duplicate data.
* Only set when include_missing_parents is true in the request.
/* This will be populated with missing gateways for the the devices on this page.
* Any gateway that is on the current page is not included in this list to avoid duplicate data.
* Only set when include_missing_gateways is true in the request.
*/
repeated Device parents = 5;
repeated Device gateways = 5;
}
}
9 changes: 4 additions & 5 deletions docs/html/device.html
Original file line number Diff line number Diff line change
Expand Up @@ -1098,12 +1098,11 @@ <h3 id="hiber.device.Device.Links">Device.Links</h3>
</tr>

<tr>
<td>parent</td>
<td>gateway</td>
<td><a href="#string">string</a></td>
<td>optional</td>
<td><p>The device directly downstream from this device.
Usually a gateway of some sorts. This device sends its data directly to its parent.
The parent will relay the data to our systems. </p></td>
<td><p>The gateway directly upstream from this device (in the direction of Mission Control).
This device sends its data directly to its gateway, which in turn relays it to Mission Control. </p></td>
</tr>

</tbody>
Expand Down Expand Up @@ -1190,7 +1189,7 @@ <h3 id="hiber.device.DeviceSelection">DeviceSelection</h3>
</tr>

<tr>
<td>with_parents</td>
<td>with_gateways</td>
<td><a href="#hiber.Filter.Modems">hiber.Filter.Modems</a></td>
<td></td>
<td><p> </p></td>
Expand Down
25 changes: 12 additions & 13 deletions docs/html/device_service.html
Original file line number Diff line number Diff line change
Expand Up @@ -909,12 +909,12 @@ <h3 id="hiber.device.ListDevice.Request">ListDevice.Request</h3>
</tr>

<tr>
<td>include_missing_parents</td>
<td>include_missing_gateways</td>
<td><a href="#bool">bool</a></td>
<td></td>
<td><p>Set this to true to populate the parents field in the response.
This will be populated with missing parents (e.g. gateways) for the the devices on this page.
Any parent that is on the current page is not included in this list to avoid duplicate data. </p></td>
<td><p>Set this to true to populate the gateways field in the response.
This will be populated with missing gateways for the the devices on this page.
Any gateway that is on the current page is not included in this list to avoid duplicate data. </p></td>
</tr>

</tbody>
Expand Down Expand Up @@ -963,12 +963,12 @@ <h3 id="hiber.device.ListDevice.Response">ListDevice.Response</h3>
</tr>

<tr>
<td>parents</td>
<td>gateways</td>
<td><a href="#hiber.device.Device">Device</a></td>
<td>repeated</td>
<td><p>This will be populated with missing parents (e.g. gateways) for the the devices on this page.
Any parent that is on the current page is not included in this list to avoid duplicate data.
Only set when include_missing_parents is true in the request. </p></td>
<td><p>This will be populated with missing gateways for the the devices on this page.
Any gateway that is on the current page is not included in this list to avoid duplicate data.
Only set when include_missing_gateways is true in the request. </p></td>
</tr>

</tbody>
Expand Down Expand Up @@ -3541,12 +3541,11 @@ <h3 id="hiber.device.Device.Links">Device.Links</h3>
</tr>

<tr>
<td>parent</td>
<td>gateway</td>
<td><a href="#string">string</a></td>
<td>optional</td>
<td><p>The device directly downstream from this device.
Usually a gateway of some sorts. This device sends its data directly to its parent.
The parent will relay the data to our systems. </p></td>
<td><p>The gateway directly upstream from this device (in the direction of Mission Control).
This device sends its data directly to its gateway, which in turn relays it to Mission Control. </p></td>
</tr>

</tbody>
Expand Down Expand Up @@ -3633,7 +3632,7 @@ <h3 id="hiber.device.DeviceSelection">DeviceSelection</h3>
</tr>

<tr>
<td>with_parents</td>
<td>with_gateways</td>
<td><a href="#hiber.Filter.Modems">hiber.Filter.Modems</a></td>
<td></td>
<td><p> </p></td>
Expand Down
9 changes: 4 additions & 5 deletions docs/html/transfer_service.html
Original file line number Diff line number Diff line change
Expand Up @@ -3061,12 +3061,11 @@ <h3 id="hiber.device.Device.Links">Device.Links</h3>
</tr>

<tr>
<td>parent</td>
<td>gateway</td>
<td><a href="#string">string</a></td>
<td>optional</td>
<td><p>The device directly downstream from this device.
Usually a gateway of some sorts. This device sends its data directly to its parent.
The parent will relay the data to our systems. </p></td>
<td><p>The gateway directly upstream from this device (in the direction of Mission Control).
This device sends its data directly to its gateway, which in turn relays it to Mission Control. </p></td>
</tr>

</tbody>
Expand Down Expand Up @@ -3153,7 +3152,7 @@ <h3 id="hiber.device.DeviceSelection">DeviceSelection</h3>
</tr>

<tr>
<td>with_parents</td>
<td>with_gateways</td>
<td><a href="#hiber.Filter.Modems">hiber.Filter.Modems</a></td>
<td></td>
<td><p> </p></td>
Expand Down
4 changes: 2 additions & 2 deletions docs/md/device.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ Collection of data about the devices it is connected to.
| Field | Type | Description |
| ----- | ---- | ----------- |
| identifiers | [repeated string](#string) | Other identifiers for this devices. Could include data like its MAC-address or otherwise unique identifier. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **_parent**.parent | [optional string](#string) | The device directly downstream from this device. Usually a gateway of some sorts. This device sends its data directly to its parent. The parent will relay the data to our systems. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **_gateway**.gateway | [optional string](#string) | The gateway directly upstream from this device (in the direction of Mission Control). This device sends its data directly to its gateway, which in turn relays it to Mission Control. |

### Device.PeripheralsEntry

Expand All @@ -185,7 +185,7 @@ Filter devices by device number, tags, etc.
| identifiers | [ hiber.Filter.ModemIdentifiers](#hiberfiltermodemidentifiers) | none |
| health_level | [ hiber.Filter.HealthLevels](#hiberfilterhealthlevels) | none |
| lifecycles | [ ModemFilter.Lifecycles](#modemfilterlifecycles) | none |
| with_parents | [ hiber.Filter.Modems](#hiberfiltermodems) | none |
| with_gateways | [ hiber.Filter.Modems](#hiberfiltermodems) | none |
| peripherals | [ hiber.Filter.Properties](#hiberfilterproperties) | none |
| filter_by_tags | [ hiber.tag.TagSelection](#hibertagtagselection) | none |
| with_last_message_in | [ hiber.TimeRange](#hibertimerange) | none |
Expand Down
8 changes: 4 additions & 4 deletions docs/md/device_service.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Update a device.
| pagination | [ hiber.Pagination](#hiberpagination) | Paginate through results. |
| sort_by | [repeated Sort](#sort) | Sort the devices with the given sort options. |
| location_selection | [ hiber.LocationSelection](#hiberlocationselection) | Filter devices by location. |
| include_missing_parents | [ bool](#bool) | Set this to true to populate the parents field in the response. This will be populated with missing parents (e.g. gateways) for the the devices on this page. Any parent that is on the current page is not included in this list to avoid duplicate data. |
| include_missing_gateways | [ bool](#bool) | Set this to true to populate the gateways field in the response. This will be populated with missing gateways for the the devices on this page. Any gateway that is on the current page is not included in this list to avoid duplicate data. |

### ListDevice.Response

Expand All @@ -183,7 +183,7 @@ Update a device.
| request | [ ListDevice.Request](#listdevicerequest) | none |
| pagination | [ hiber.Pagination.Result](#hiberpaginationresult) | none |
| sorted_by | [repeated Sort](#sort) | none |
| parents | [repeated Device](#device) | This will be populated with missing parents (e.g. gateways) for the the devices on this page. Any parent that is on the current page is not included in this list to avoid duplicate data. Only set when include_missing_parents is true in the request. |
| gateways | [repeated Device](#device) | This will be populated with missing gateways for the the devices on this page. Any gateway that is on the current page is not included in this list to avoid duplicate data. Only set when include_missing_gateways is true in the request. |

### UpdateDevice

Expand Down Expand Up @@ -314,7 +314,7 @@ Collection of data about the devices it is connected to.
| Field | Type | Description |
| ----- | ---- | ----------- |
| identifiers | [repeated string](#string) | Other identifiers for this devices. Could include data like its MAC-address or otherwise unique identifier. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **_parent**.parent | [optional string](#string) | The device directly downstream from this device. Usually a gateway of some sorts. This device sends its data directly to its parent. The parent will relay the data to our systems. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **_gateway**.gateway | [optional string](#string) | The gateway directly upstream from this device (in the direction of Mission Control). This device sends its data directly to its gateway, which in turn relays it to Mission Control. |

### hiber.device.Device.PeripheralsEntry

Expand All @@ -337,7 +337,7 @@ Filter devices by device number, tags, etc.
| identifiers | [ hiber.Filter.ModemIdentifiers](#hiberfiltermodemidentifiers) | none |
| health_level | [ hiber.Filter.HealthLevels](#hiberfilterhealthlevels) | none |
| lifecycles | [ hiber.device.ModemFilter.Lifecycles](#hiberdevicemodemfilterlifecycles) | none |
| with_parents | [ hiber.Filter.Modems](#hiberfiltermodems) | none |
| with_gateways | [ hiber.Filter.Modems](#hiberfiltermodems) | none |
| peripherals | [ hiber.Filter.Properties](#hiberfilterproperties) | none |
| filter_by_tags | [ hiber.tag.TagSelection](#hibertagtagselection) | none |
| with_last_message_in | [ hiber.TimeRange](#hibertimerange) | none |
Expand Down
4 changes: 2 additions & 2 deletions docs/md/transfer_service.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ Collection of data about the devices it is connected to.
| Field | Type | Description |
| ----- | ---- | ----------- |
| identifiers | [repeated string](#string) | Other identifiers for this devices. Could include data like its MAC-address or otherwise unique identifier. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **_parent**.parent | [optional string](#string) | The device directly downstream from this device. Usually a gateway of some sorts. This device sends its data directly to its parent. The parent will relay the data to our systems. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) **_gateway**.gateway | [optional string](#string) | The gateway directly upstream from this device (in the direction of Mission Control). This device sends its data directly to its gateway, which in turn relays it to Mission Control. |

### hiber.device.Device.PeripheralsEntry

Expand All @@ -265,7 +265,7 @@ Filter devices by device number, tags, etc.
| identifiers | [ hiber.Filter.ModemIdentifiers](#hiberfiltermodemidentifiers) | none |
| health_level | [ hiber.Filter.HealthLevels](#hiberfilterhealthlevels) | none |
| lifecycles | [ hiber.device.ModemFilter.Lifecycles](#hiberdevicemodemfilterlifecycles) | none |
| with_parents | [ hiber.Filter.Modems](#hiberfiltermodems) | none |
| with_gateways | [ hiber.Filter.Modems](#hiberfiltermodems) | none |
| peripherals | [ hiber.Filter.Properties](#hiberfilterproperties) | none |
| filter_by_tags | [ hiber.tag.TagSelection](#hibertagtagselection) | none |
| with_last_message_in | [ hiber.TimeRange](#hibertimerange) | none |
Expand Down

0 comments on commit 05e2660

Please sign in to comment.