From 7c3ef40c6a003a03f67a5d7478b13a56e57b984f Mon Sep 17 00:00:00 2001 From: Wouter Bouvy Date: Mon, 23 Jan 2023 11:57:31 +0100 Subject: [PATCH] 0.137.0 --- CHANGELOG.md | 42 + base.proto | 8 +- changelog/README.md | 2 +- docs/html/assignment.html | 286 +- docs/html/certificate.html | 26 +- docs/html/currentuser.html | 97 +- docs/html/dashboard.html | 460 +- docs/html/device.html | 286 +- docs/html/device_service.html | 286 +- docs/html/easypulse.html | 8548 ----------------- docs/html/email_notifications.html | 26 +- docs/html/event.html | 705 +- docs/html/export.html | 26 +- docs/html/field.html | 26 +- docs/html/field_service.html | 286 +- docs/html/health.html | 26 +- docs/html/integration_mqtt.html | 26 +- docs/html/integration_slack.html | 26 +- docs/html/map.html | 426 +- docs/html/message.html | 286 +- docs/html/modem.html | 415 +- docs/html/modem_alarm.html | 286 +- docs/html/modem_claim.html | 26 +- docs/html/modem_message_body_parser.html | 286 +- docs/html/modem_message_downlink.html | 286 +- docs/html/modem_transfer.html | 357 +- docs/html/named_location.html | 26 +- docs/html/organization.html | 97 +- docs/html/permission.html | 16 +- docs/html/publisher.html | 26 +- docs/html/satellite.html | 26 +- docs/html/simulation.html | 26 +- docs/html/simulation_service.html | 286 +- docs/html/status.html | 40 +- docs/html/tag.html | 26 +- docs/html/testing.html | 286 +- docs/html/token.html | 42 +- docs/html/transfer.html | 517 + docs/html/transfer_service.html | 4618 +++++++++ docs/html/user.html | 26 +- docs/html/value.html | 26 +- docs/html/value_service.html | 286 +- docs/html/webhook.html | 26 +- docs/md/assignment.md | 36 +- docs/md/certificate.md | 6 +- docs/md/currentuser.md | 26 +- docs/md/dashboard.md | 67 +- docs/md/device.md | 36 +- docs/md/device_service.md | 36 +- docs/md/easypulse.md | 2043 ---- docs/md/email_notifications.md | 6 +- docs/md/event.md | 143 +- docs/md/export.md | 6 +- docs/md/field.md | 6 +- docs/md/field_service.md | 36 +- docs/md/health.md | 6 +- docs/md/integration_mqtt.md | 6 +- docs/md/integration_slack.md | 6 +- docs/md/map.md | 72 +- docs/md/message.md | 36 +- docs/md/modem.md | 107 +- docs/md/modem_alarm.md | 36 +- docs/md/modem_claim.md | 6 +- docs/md/modem_message_body_parser.md | 36 +- docs/md/modem_message_downlink.md | 36 +- docs/md/modem_transfer.md | 60 +- docs/md/named_location.md | 6 +- docs/md/organization.md | 32 +- docs/md/permission.md | 5 +- docs/md/publisher.md | 6 +- docs/md/satellite.md | 6 +- docs/md/simulation.md | 6 +- docs/md/simulation_service.md | 36 +- docs/md/status.md | 8 +- docs/md/tag.md | 6 +- docs/md/testing.md | 36 +- docs/md/token.md | 11 +- docs/md/transfer.md | 75 + docs/md/transfer_service.md | 1268 +++ docs/md/user.md | 6 +- docs/md/value.md | 6 +- docs/md/value_service.md | 36 +- docs/md/webhook.md | 6 +- easypulse.proto | 750 -- event-json-examples/export-created.json | 4 +- event-json-examples/export-failed.json | 4 +- event-json-examples/export-ready.json | 4 +- event-json-examples/modem-alarm.json | 4 +- .../modem-transfer-cancelled.json | 86 - .../modem-transfer-not-received.json | 107 - .../modem-transfer-received.json | 86 - ...odem-transfer-return-transfer-started.json | 167 - .../modem-transfer-started.json | 82 - event-json-examples/transfer.json | 57 + event.proto | 54 +- map.proto | 29 +- modem.proto | 80 +- modem_transfer.proto | 40 +- organization.proto | 20 +- permission.proto | 17 +- satellite.proto | 99 - status.proto | 8 +- subscription.proto | 14 - transfer.proto | 49 + transfer_service.proto | 91 + 105 files changed, 7600 insertions(+), 18613 deletions(-) delete mode 100644 docs/html/easypulse.html create mode 100644 docs/html/transfer.html create mode 100644 docs/html/transfer_service.html delete mode 100644 docs/md/easypulse.md create mode 100644 docs/md/transfer.md create mode 100644 docs/md/transfer_service.md delete mode 100644 easypulse.proto delete mode 100644 event-json-examples/modem-transfer-cancelled.json delete mode 100644 event-json-examples/modem-transfer-not-received.json delete mode 100644 event-json-examples/modem-transfer-received.json delete mode 100644 event-json-examples/modem-transfer-return-transfer-started.json delete mode 100644 event-json-examples/modem-transfer-started.json create mode 100644 event-json-examples/transfer.json delete mode 100644 satellite.proto delete mode 100644 subscription.proto create mode 100644 transfer.proto create mode 100644 transfer_service.proto diff --git a/CHANGELOG.md b/CHANGELOG.md index a939a38..02546f4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,19 +1,61 @@ # Changelog Hiber API +### 0.137 (2023-01-23) + +- Removed all satellite-related leftovers: + - Removed `satellite.proto` which contained the unused `SatelliteService`. + - Removed `GroundStation` and `Satellite` from `map.proto`. + - Removed `include_ground_stations` and `include_satellites` from `TileMapRequest`. + - Removed `ground_stations` and `satellites` from `TileMapRequest.Response`. + - Removed `ground_stations` and `satellites` from `StatusRequest.Response`. +- Removed `subscription.proto` and `ModemSelection.with_service_type`. + +### 0.136 (2023-01-16) + +##### AssignmentService + +- Limited (un)assigning parsers to the owners of those parsers. + - Inherited parsers can now only be (un)assigned by their owners, impersonated into the child organization. + +##### ModemTransferService + +- Deprecated the ModemTransferService to be replaced by the much simpler TransferService. + - Reimplemented the ModemTransferService with the TransferService where possible. + - Some new limitation apply to the ModemTransferService because of this: + - transfers are always marked as received immediately + - returns are no longer supported + +##### TransferService + +- Introduced the TransferService as simple reimplementation of the transfer logic. + - Instead of marking received / not received, etc, a transfer is now automatic. + - Transfers are only allowed if you have access to the recipient organization. + +#### Events + +- Message export ready event will now contain modem tags in the description. + +##### OrganizationService + +- Removed the confirmation flow for organization delete. + ### 0.135 (2023-01-02) ##### ModemMessageBodyParserService - Added possibility to define a filter on modem message metadata. The parser will only be applied to a message if the metadata matches. + ##### ValueService - Fixed a bug where modem data was merged together when requesting data for multiple modems. - Fixed a bug where the modem field was never set. + ##### ModemClaimService - Removed the modem claim service. - The proto is left in place to not break build immediately, but the service itself wil no longer be supported. + ##### EasypulseService - Removed the Easypulse service. diff --git a/base.proto b/base.proto index 117c9c0..bee7fea 100644 --- a/base.proto +++ b/base.proto @@ -261,11 +261,7 @@ enum EventType { ASSIGNED = 63; UNASSIGNED = 64; - MODEM_TRANSFER_STARTED = 17; - MODEM_TRANSFER_RECEIVED = 18; - MODEM_TRANSFER_CANCELLED = 19; - MODEM_TRANSFER_NOT_RECEIVED = 20; - MODEM_TRANSFER_RETURN_TRANSFER_STARTED = 21; + TRANSFER = 18; PUBLISHER_CREATED = 1; PUBLISHER_UPDATED = 2; @@ -289,7 +285,7 @@ enum EventType { EXPORT_READY = 66; EXPORT_FAILED = 67; - reserved 6, 7, 13, 14, 16, 22 to 24, 27, 28, 29, 30; + reserved 6, 7, 13, 14, 16, 17, 19 to 24, 27, 28, 29, 30; } /* Filters used in many api calls to filter the data sources, results, etc. diff --git a/changelog/README.md b/changelog/README.md index 79a6cda..b593b90 100644 --- a/changelog/README.md +++ b/changelog/README.md @@ -5,7 +5,7 @@ merge conflicts on releases with the changelog file. On a release, all files in format, will be added to the `CHANGELOG.md` file in the parent directory in lexicographical order. The format of the filename should be: ``` -WEB-.md +.md ``` where `` can be anything that describes the change. A typical format would be to use `WEB--` where `` is the Jira ticket number that this change diff --git a/docs/html/assignment.html b/docs/html/assignment.html index 4afb870..c7f6b3e 100644 --- a/docs/html/assignment.html +++ b/docs/html/assignment.html @@ -596,10 +596,6 @@

Table of Contents

MModem -
  • - MModem.ActiveSubscription -
    • -
  • MModem.ConnectedDeviceInfo
    • @@ -620,10 +616,6 @@

    Table of Contents

    MModem.TechnicalData -
  • - MModem.Transfer -
    • -
  • MModemHealthCount
    • @@ -741,14 +733,6 @@

    Table of Contents

    EModem.Lifecycle -
  • - EModem.Peripherals.HiberAntenna -
    • - -
  • - EModem.Transfer.Status -
    • -
  • EModem.Type
    • @@ -4275,35 +4259,11 @@

    EventType

    - MODEM_TRANSFER_STARTED - 17 -

    - - - - MODEM_TRANSFER_RECEIVED + TRANSFER 18

    - - MODEM_TRANSFER_CANCELLED - 19 -

    - - - - MODEM_TRANSFER_NOT_RECEIVED - 20 -

    - - - - MODEM_TRANSFER_RETURN_TRANSFER_STARTED - 21 -

    - - PUBLISHER_CREATED 1 @@ -5236,24 +5196,6 @@

    ListModemsRequest

    Sort the modem with the given sort options.

    - - include_inbound_modems - bool - -

    Whether to include inbound modems in the results. -Inbound modems are modems that are in a transfer that has been sent *to* your organization, but that has not -been marked as received yet.

    - - - - include_outbound_modems - bool - -

    Whether to include outbound modems in the results. -Inbound modems are modems that are in a transfer that has been sent *from* your organization, but that has not -been marked as received yet.

    - - child_organizations hiber.Filter.ChildOrganizations @@ -5562,18 +5504,11 @@

    Modem

    - - active_subscription - Modem.ActiveSubscription - -

    additional information

    - - technical Modem.TechnicalData -

    +

    additional information

    @@ -5583,13 +5518,6 @@

    Modem

    - - in_transfer - Modem.Transfer - -

    - - notes string @@ -5741,44 +5669,6 @@

    Fields with deprecated option

    -

    Modem.ActiveSubscription

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    typehiber.organization.subscription.ServiceType

    start_datehiber.Timestamp

    end_datehiber.Timestamp

    - - - - -

    Modem.ConnectedDeviceInfo

    Additional information when this modem is a connected device.

    @@ -5846,13 +5736,6 @@

    Modem.Peripherals

    - - hiber_antenna - Modem.Peripherals.HiberAntenna - -

    Deprecated.

    - - gps bool @@ -5878,27 +5761,6 @@

    Modem.Peripherals

    - - -

    Fields with deprecated option

    - - - - - - - - - - - - - - - -
    NameOption
    hiber_antenna

    true

    - - @@ -5943,20 +5805,6 @@

    Modem.TechnicalData

    - - hardware_name - string - -

    - - - - firmware_version_name - string - -

    - - hardware_production_batch string @@ -5978,37 +5826,6 @@

    Modem.TechnicalData

    -

    Modem.Transfer

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    statusModem.Transfer.Status

    identifierstring

    - - - - -

    ModemHealthCount

    @@ -6564,13 +6381,6 @@

    ModemSelection

    - - with_service_type - hiber.organization.subscription.ServiceType - repeated -

    - - health hiber.Health @@ -7308,13 +7118,6 @@

    UpdatePeripheralsRequest

    - - hiber_antenna - Modem.Peripherals.HiberAntenna - -

    - - gps hiber.UpdateBoolean @@ -7621,87 +7424,6 @@

    Modem.Lifecycle

    -

    Modem.Peripherals.HiberAntenna

    -

    A Hiber antenna is required for the modem to function.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    DEFAULT0

    HIBER_PANDA1

    HIBER_GRIZZLY2

    HIBER_BLACK3

    CUSTOM4

    - -

    Modem.Transfer.Status

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    NONE0

    INBOUND1

    Modem has been shipped or transferred to you and is inbound. -When you mark the transfer as received, the modems are added to your organization. -If you encounter any issues, you can mark modems for return using the ModemTransferReturnService.

    OUTBOUND2

    Modem has been shipped or transferred by you and is outbound. -When the transfer is received, the modems are removed from your organization, though the recipient may -still return them later.

    RETURNING3

    You shipped this modem to another organization, but they are returning it. -When you mark the transfer as received, the modems are added back to your organization.

    -

    Modem.Type

    The effective type of this modem.

    Type can depend on the hardware itself as well as network topology.

    @@ -7717,9 +7439,9 @@

    Modem.Type

    - + - + diff --git a/docs/html/certificate.html b/docs/html/certificate.html index 1cd1bdd..64c38cf 100644 --- a/docs/html/certificate.html +++ b/docs/html/certificate.html @@ -2554,35 +2554,11 @@

    EventType

    - - - - - - - + - - - - - - - - - - - - - - - - - - diff --git a/docs/html/currentuser.html b/docs/html/currentuser.html index 0e6d786..5c3f499 100644 --- a/docs/html/currentuser.html +++ b/docs/html/currentuser.html @@ -484,14 +484,6 @@

    Table of Contents

    MCreateOrganizationRequest -
  • - MDeleteOrganizationConfirmationRequest -
    • - -
  • - MDeleteOrganizationConfirmationRequest.Response -
    • -
  • MDeleteOrganizationRequest
    • @@ -2896,35 +2888,11 @@

    EventType

    - - - - - - - + - - - - - - - - - - - - - - - - - - @@ -3448,51 +3416,6 @@

    CreateOrganizationRequest< -

    DeleteOrganizationConfirmationRequest

    -

    - - -
    DIRECTDEVICE 1

    A devices that directly connects to the satellite

    A device that is not currently connected to a gateway.
    MODEM_TRANSFER_STARTED17

    MODEM_TRANSFER_RECEIVEDTRANSFER 18

    MODEM_TRANSFER_CANCELLED19

    MODEM_TRANSFER_NOT_RECEIVED20

    MODEM_TRANSFER_RETURN_TRANSFER_STARTED21

    PUBLISHER_CREATED 1
    MODEM_TRANSFER_STARTED17

    MODEM_TRANSFER_RECEIVEDTRANSFER 18

    MODEM_TRANSFER_CANCELLED19

    MODEM_TRANSFER_NOT_RECEIVED20

    MODEM_TRANSFER_RETURN_TRANSFER_STARTED21

    PUBLISHER_CREATED 1
    - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    parent_organizationstring

    Pick the organization to use (/impersonate). If unset, your default organization is used.

    organization_to_deletestring

    The organization to delete. Required.

    deletion_tokenstring

    The deletion_token for deletion

    - - - - - -

    DeleteOrganizationConfirmationRequest.Response

    -

    - - - - -

    DeleteOrganizationRequest

    @@ -3542,17 +3465,10 @@

    DeleteOrganizatio - deletion_token - string - -

    Token to use with DeleteOrganizationConfirmationRequest.

    - - - - organizations_to_be_deleted + organizations_deleted OrganizationTree -

    The organizations that will be deleted.

    +

    The organizations that were deleted.

    @@ -4331,13 +4247,6 @@

    OrganizationService

    - - DeleteConfirmation - DeleteOrganizationConfirmationRequest - DeleteOrganizationConfirmationRequest.Response -

    - - Tree OrganizationTreeRequest diff --git a/docs/html/dashboard.html b/docs/html/dashboard.html index 9863d86..bda73fd 100644 --- a/docs/html/dashboard.html +++ b/docs/html/dashboard.html @@ -449,6 +449,14 @@

    Table of Contents

    MEvent.TokenEvent.TokenExpiryWarningEvent +
  • + MEvent.TransferEvent +
    • + +
  • + MEvent.TransferEvent.DeprecatedTransfer +
    • +
  • MEvent.UserEvent
    • @@ -648,10 +656,6 @@

    Table of Contents

    MModem -
  • - MModem.ActiveSubscription -
    • -
  • MModem.ConnectedDeviceInfo
    • @@ -672,10 +676,6 @@

    Table of Contents

    MModem.TechnicalData -
  • - MModem.Transfer -
    • -
  • MModemHealthCount
    • @@ -793,14 +793,6 @@

    Table of Contents

    EModem.Lifecycle -
  • - EModem.Peripherals.HiberAntenna -
    • - -
  • - EModem.Transfer.Status -
    • -
  • EModem.Type
    • @@ -1358,36 +1350,8 @@

    Event

    - modem_transfer_started - Event.ModemTransferEvent.ModemTransferStartedEvent - -

    - - - - modem_transfer_cancelled - Event.ModemTransferEvent.ModemTransferCancelledEvent - -

    - - - - modem_transfer_received - Event.ModemTransferEvent.ModemTransferReceivedEvent - -

    - - - - modem_transfer_not_received - Event.ModemTransferEvent.ModemTransferNotReceivedEvent - -

    - - - - modem_transfer_return_transfer_started - Event.ModemTransferEvent.ModemTransferReturnTransferStartedEvent + transfer + Event.TransferEvent

    @@ -3068,13 +3032,6 @@

    Event.ModemEvent.ModemUp

    - - antenna - hiber.modem.Modem.Peripherals.HiberAntenna - -

    - - custom_antenna hiber.UpdateClearableString @@ -4687,6 +4644,159 @@

    Event.TokenEvent.T +

    Event.TransferEvent

    +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypeLabelDescription
    organizationstring

    timehiber.Timestamp

    tagshiber.tag.Tagrepeated

    titlestring

    descriptionstring

    transferhiber.transfer.Transfer

    deprecated_transferhiber.modem.ModemTransfer

    Deprecated. Deprecated, here to be backwards compatible with ModemTransferEvents.

    + + + + +

    Fields with deprecated option

    + + + + + + + + + + + + + + + +
    NameOption
    deprecated_transfer

    true

    + + + + + +

    Event.TransferEvent.DeprecatedTransfer

    +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypeLabelDescription
    identifierstring

    modem_numbersstringrepeated

    sender_organizationstring

    recipient_organizationstring

    commentstring

    timehiber.Timestamp

    tagshiber.tag.Tagrepeated

    + + + + +

    Event.UserEvent

    @@ -6359,24 +6469,6 @@

    ListModemsRequest

    Sort the modem with the given sort options.

    - - include_inbound_modems - bool - -

    Whether to include inbound modems in the results. -Inbound modems are modems that are in a transfer that has been sent *to* your organization, but that has not -been marked as received yet.

    - - - - include_outbound_modems - bool - -

    Whether to include outbound modems in the results. -Inbound modems are modems that are in a transfer that has been sent *from* your organization, but that has not -been marked as received yet.

    - - child_organizations hiber.Filter.ChildOrganizations @@ -6685,18 +6777,11 @@

    Modem

    - - active_subscription - Modem.ActiveSubscription - -

    additional information

    - - technical Modem.TechnicalData -

    +

    additional information

    @@ -6706,13 +6791,6 @@

    Modem

    - - in_transfer - Modem.Transfer - -

    - - notes string @@ -6864,44 +6942,6 @@

    Fields with deprecated option

    -

    Modem.ActiveSubscription

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    typehiber.organization.subscription.ServiceType

    start_datehiber.Timestamp

    end_datehiber.Timestamp

    - - - - -

    Modem.ConnectedDeviceInfo

    Additional information when this modem is a connected device.

    @@ -6969,13 +7009,6 @@

    Modem.Peripherals

    - - hiber_antenna - Modem.Peripherals.HiberAntenna - -

    Deprecated.

    - - gps bool @@ -7001,27 +7034,6 @@

    Modem.Peripherals

    - - -

    Fields with deprecated option

    - - - - - - - - - - - - - - - -
    NameOption
    hiber_antenna

    true

    - - @@ -7066,20 +7078,6 @@

    Modem.TechnicalData

    - - hardware_name - string - -

    - - - - firmware_version_name - string - -

    - - hardware_production_batch string @@ -7101,37 +7099,6 @@

    Modem.TechnicalData

    -

    Modem.Transfer

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    statusModem.Transfer.Status

    identifierstring

    - - - - -

    ModemHealthCount

    @@ -7687,13 +7654,6 @@

    ModemSelection

    - - with_service_type - hiber.organization.subscription.ServiceType - repeated -

    - - health hiber.Health @@ -8431,13 +8391,6 @@

    UpdatePeripheralsRequest

    - - hiber_antenna - Modem.Peripherals.HiberAntenna - -

    - - gps hiber.UpdateBoolean @@ -8744,87 +8697,6 @@

    Modem.Lifecycle

    -

    Modem.Peripherals.HiberAntenna

    -

    A Hiber antenna is required for the modem to function.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    DEFAULT0

    HIBER_PANDA1

    HIBER_GRIZZLY2

    HIBER_BLACK3

    CUSTOM4

    - -

    Modem.Transfer.Status

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    NONE0

    INBOUND1

    Modem has been shipped or transferred to you and is inbound. -When you mark the transfer as received, the modems are added to your organization. -If you encounter any issues, you can mark modems for return using the ModemTransferReturnService.

    OUTBOUND2

    Modem has been shipped or transferred by you and is outbound. -When the transfer is received, the modems are removed from your organization, though the recipient may -still return them later.

    RETURNING3

    You shipped this modem to another organization, but they are returning it. -When you mark the transfer as received, the modems are added back to your organization.

    -

    Modem.Type

    The effective type of this modem.

    Type can depend on the hardware itself as well as network topology.

    @@ -8840,9 +8712,9 @@

    Modem.Type

    - + - + diff --git a/docs/html/device.html b/docs/html/device.html index c01cff5..fa2ae5a 100644 --- a/docs/html/device.html +++ b/docs/html/device.html @@ -575,10 +575,6 @@

    Table of Contents

    MModem -
  • - MModem.ActiveSubscription -
    • -
  • MModem.ConnectedDeviceInfo
    • @@ -599,10 +595,6 @@

    Table of Contents

    MModem.TechnicalData -
  • - MModem.Transfer -
    • -
  • MModemHealthCount
    • @@ -720,14 +712,6 @@

    Table of Contents

    EModem.Lifecycle -
  • - EModem.Peripherals.HiberAntenna -
    • - -
  • - EModem.Transfer.Status -
    • -
  • EModem.Type
    • @@ -3012,35 +2996,11 @@

    EventType

    - - - - - - - + - - - - - - - - - - - - - - - - - - @@ -4593,24 +4553,6 @@

    ListModemsRequest

    - - - - - - - - - - - - - - @@ -4919,18 +4861,11 @@

    Modem

    - - - - - - - - + @@ -4940,13 +4875,6 @@

    Modem

    - - - - - - - @@ -5098,44 +5026,6 @@

    Fields with deprecated option

    -

    Modem.ActiveSubscription

    -

    - - -
    DIRECTDEVICE 1

    A devices that directly connects to the satellite

    A device that is not currently connected to a gateway.
    MODEM_TRANSFER_STARTED17

    MODEM_TRANSFER_RECEIVEDTRANSFER 18

    MODEM_TRANSFER_CANCELLED19

    MODEM_TRANSFER_NOT_RECEIVED20

    MODEM_TRANSFER_RETURN_TRANSFER_STARTED21

    PUBLISHER_CREATED 1

    Sort the modem with the given sort options.

    include_inbound_modemsbool

    Whether to include inbound modems in the results. -Inbound modems are modems that are in a transfer that has been sent *to* your organization, but that has not -been marked as received yet.

    include_outbound_modemsbool

    Whether to include outbound modems in the results. -Inbound modems are modems that are in a transfer that has been sent *from* your organization, but that has not -been marked as received yet.

    child_organizations hiber.Filter.ChildOrganizations

    active_subscriptionModem.ActiveSubscription

    additional information

    technical Modem.TechnicalData

    additional information

    in_transferModem.Transfer

    notes string
    - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    typehiber.organization.subscription.ServiceType

    start_datehiber.Timestamp

    end_datehiber.Timestamp

    - - - - -

    Modem.ConnectedDeviceInfo

    Additional information when this modem is a connected device.

    @@ -5203,13 +5093,6 @@

    Modem.Peripherals

    - - hiber_antenna - Modem.Peripherals.HiberAntenna - -

    Deprecated.

    - - gps bool @@ -5235,27 +5118,6 @@

    Modem.Peripherals

    - - -

    Fields with deprecated option

    - - - - - - - - - - - - - - - -
    NameOption
    hiber_antenna

    true

    - - @@ -5300,20 +5162,6 @@

    Modem.TechnicalData

    - - hardware_name - string - -

    - - - - firmware_version_name - string - -

    - - hardware_production_batch string @@ -5335,37 +5183,6 @@

    Modem.TechnicalData

    -

    Modem.Transfer

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    statusModem.Transfer.Status

    identifierstring

    - - - - -

    ModemHealthCount

    @@ -5921,13 +5738,6 @@

    ModemSelection

    - - with_service_type - hiber.organization.subscription.ServiceType - repeated -

    - - health hiber.Health @@ -6665,13 +6475,6 @@

    UpdatePeripheralsRequest

    - - hiber_antenna - Modem.Peripherals.HiberAntenna - -

    - - gps hiber.UpdateBoolean @@ -6978,87 +6781,6 @@

    Modem.Lifecycle

    -

    Modem.Peripherals.HiberAntenna

    -

    A Hiber antenna is required for the modem to function.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    DEFAULT0

    HIBER_PANDA1

    HIBER_GRIZZLY2

    HIBER_BLACK3

    CUSTOM4

    - -

    Modem.Transfer.Status

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    NONE0

    INBOUND1

    Modem has been shipped or transferred to you and is inbound. -When you mark the transfer as received, the modems are added to your organization. -If you encounter any issues, you can mark modems for return using the ModemTransferReturnService.

    OUTBOUND2

    Modem has been shipped or transferred by you and is outbound. -When the transfer is received, the modems are removed from your organization, though the recipient may -still return them later.

    RETURNING3

    You shipped this modem to another organization, but they are returning it. -When you mark the transfer as received, the modems are added back to your organization.

    -

    Modem.Type

    The effective type of this modem.

    Type can depend on the hardware itself as well as network topology.

    @@ -7074,9 +6796,9 @@

    Modem.Type

    - + - + diff --git a/docs/html/device_service.html b/docs/html/device_service.html index 8bc26d9..33be4bb 100644 --- a/docs/html/device_service.html +++ b/docs/html/device_service.html @@ -543,10 +543,6 @@

    Table of Contents

    MModem -
  • - MModem.ActiveSubscription -
    • -
  • MModem.ConnectedDeviceInfo
    • @@ -567,10 +563,6 @@

    Table of Contents

    MModem.TechnicalData -
  • - MModem.Transfer -
    • -
  • MModemHealthCount
    • @@ -688,14 +680,6 @@

    Table of Contents

    EModem.Lifecycle -
  • - EModem.Peripherals.HiberAntenna -
    • - -
  • - EModem.Transfer.Status -
    • -
  • EModem.Type
    • @@ -2972,35 +2956,11 @@

    EventType

    - - - - - - - + - - - - - - - - - - - - - - - - - - @@ -4367,24 +4327,6 @@

    ListModemsRequest

    - - - - - - - - - - - - - - @@ -4693,18 +4635,11 @@

    Modem

    - - - - - - - - + @@ -4714,13 +4649,6 @@

    Modem

    - - - - - - - @@ -4872,44 +4800,6 @@

    Fields with deprecated option

    -

    Modem.ActiveSubscription

    -

    - - -
    DIRECTDEVICE 1

    A devices that directly connects to the satellite

    A device that is not currently connected to a gateway.
    MODEM_TRANSFER_STARTED17

    MODEM_TRANSFER_RECEIVEDTRANSFER 18

    MODEM_TRANSFER_CANCELLED19

    MODEM_TRANSFER_NOT_RECEIVED20

    MODEM_TRANSFER_RETURN_TRANSFER_STARTED21

    PUBLISHER_CREATED 1

    Sort the modem with the given sort options.

    include_inbound_modemsbool

    Whether to include inbound modems in the results. -Inbound modems are modems that are in a transfer that has been sent *to* your organization, but that has not -been marked as received yet.

    include_outbound_modemsbool

    Whether to include outbound modems in the results. -Inbound modems are modems that are in a transfer that has been sent *from* your organization, but that has not -been marked as received yet.

    child_organizations hiber.Filter.ChildOrganizations

    active_subscriptionModem.ActiveSubscription

    additional information

    technical Modem.TechnicalData

    additional information

    in_transferModem.Transfer

    notes string
    - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    typehiber.organization.subscription.ServiceType

    start_datehiber.Timestamp

    end_datehiber.Timestamp

    - - - - -

    Modem.ConnectedDeviceInfo

    Additional information when this modem is a connected device.

    @@ -4977,13 +4867,6 @@

    Modem.Peripherals

    - - hiber_antenna - Modem.Peripherals.HiberAntenna - -

    Deprecated.

    - - gps bool @@ -5009,27 +4892,6 @@

    Modem.Peripherals

    - - -

    Fields with deprecated option

    - - - - - - - - - - - - - - - -
    NameOption
    hiber_antenna

    true

    - - @@ -5074,20 +4936,6 @@

    Modem.TechnicalData

    - - hardware_name - string - -

    - - - - firmware_version_name - string - -

    - - hardware_production_batch string @@ -5109,37 +4957,6 @@

    Modem.TechnicalData

    -

    Modem.Transfer

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    statusModem.Transfer.Status

    identifierstring

    - - - - -

    ModemHealthCount

    @@ -5695,13 +5512,6 @@

    ModemSelection

    - - with_service_type - hiber.organization.subscription.ServiceType - repeated -

    - - health hiber.Health @@ -6439,13 +6249,6 @@

    UpdatePeripheralsRequest

    - - hiber_antenna - Modem.Peripherals.HiberAntenna - -

    - - gps hiber.UpdateBoolean @@ -6752,87 +6555,6 @@

    Modem.Lifecycle

    -

    Modem.Peripherals.HiberAntenna

    -

    A Hiber antenna is required for the modem to function.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    DEFAULT0

    HIBER_PANDA1

    HIBER_GRIZZLY2

    HIBER_BLACK3

    CUSTOM4

    - -

    Modem.Transfer.Status

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    NONE0

    INBOUND1

    Modem has been shipped or transferred to you and is inbound. -When you mark the transfer as received, the modems are added to your organization. -If you encounter any issues, you can mark modems for return using the ModemTransferReturnService.

    OUTBOUND2

    Modem has been shipped or transferred by you and is outbound. -When the transfer is received, the modems are removed from your organization, though the recipient may -still return them later.

    RETURNING3

    You shipped this modem to another organization, but they are returning it. -When you mark the transfer as received, the modems are added back to your organization.

    -

    Modem.Type

    The effective type of this modem.

    Type can depend on the hardware itself as well as network topology.

    @@ -6848,9 +6570,9 @@

    Modem.Type

    - + - + diff --git a/docs/html/easypulse.html b/docs/html/easypulse.html deleted file mode 100644 index 0520123..0000000 --- a/docs/html/easypulse.html +++ /dev/null @@ -1,8548 +0,0 @@ - - - - - Protocol Documentation - - - - - - - - - - -

    Protocol Documentation

    - -

    Table of Contents

    - -
    - -
    - - - -
    -

    easypulse.proto

    Top -
    -

    The easypulse service has been discontinued.

    It is no longer supported, and will return an error when used.

    TODO(2023-01-10) remove the proto file

    - - -

    Easypulse

    -

    - - - - - -

    Easypulse.Asset

    -

    Asset in your organization.

    An asset is a view of a modem, with assumptions about message data fields handled in the API.

    In addition, an Asset can be enriched with aggregations of the data fields when requested (for example,

    fuel level average over the past month, or total run time in the past week).

    - - -
    DIRECTDEVICE 1

    A devices that directly connects to the satellite

    A device that is not currently connected to a gateway.
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    organizationstring

    The organization the asset is in.

    numberstring

    The modem number for the Asset.

    namestring

    The custom name for the Asset, defaults to modem number.

    external_identifierstring

    Optional external identifier the Asset may have.

    peripheralsEasypulse.Asset.PeripheralsEntryrepeated

    A key value map of peripherals for the Assets.

    notesstring

    Add additional notes to an asset.

    secure_notesstring

    Add additional notes to an asset that only people with the permission can access.

    time_zonestring

    The timezone configured for the asset.

    health_levelhiber.health.HealthLevel

    Health level based on the modem alarm and some always-present alarms.

    lifecycleEasypulse.Asset.Lifecycle

    tagshiber.tag.Tagrepeated

    Tags (or groups, when used in Mission Control) this asset is in.

    last_updateEasypulse.Asset.LastUpdate

    When this asset was last updated.

    odometerhiber.value.Value.Numeric.Distance

    Current value of the odometer.

    engine_runtimehiber.Duration

    Duration of total hours the engine has ran.

    engine_idle_timehiber.Duration

    Duration of total hours the engine has idled.

    fuel_used_runninghiber.value.Value.Numeric.Volume

    The total amount of fuel used by this vehicle.

    fuel_used_idlinghiber.value.Value.Numeric.Volume

    The total amount of fuel used by this vehicle while idling.

    power_take_off_engagement_countint32

    The amount of times the power-take-off was engaged

    power_take_off_engagement_durationhiber.Duration

    The duration the power-take-off was engaged for

    engine_oil_temperaturehiber.value.Value.Numeric.Temperature

    Engine temperature.

    fuel_levelhiber.value.Value.Numeric.Percentage

    The most recent fuel level.

    temperaturehiber.value.Value.Numeric.Temperature

    The most recent temperature in degrees Celsius.

    speedhiber.value.Value.Numeric.Speed

    The most recent speed measurement.

    rpmint32

    The most recent peak rpm measurement.

    tire_pressurehiber.value.Value.Numeric.Pressure

    The most recent tire pressure measurement.

    battery_levelhiber.value.Value.Numeric.BatteryLevel

    The most recent battery level.

    locationhiber.Location

    The most recently reported location.

    aggregationsEasypulse.Asset.AggregationsEntryrepeated

    Any aggregations added when this asset was requested.

    tell_talesEasypulse.TellTalerepeated

    List of tell-tale status indicators. The order of the list is intentional.

    - - - - - -

    Easypulse.Asset.AggregationsEntry

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    keystring

    valueEasypulse.History.Response

    - - - - - -

    Easypulse.Asset.LastUpdate

    -

    Information about the last update we received from this asset.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    iduint64

    received_athiber.Timestamp

    Time the server has received the last update.

    sent_athiber.Timestamp

    Time the asset sent the last update.

    bodyhiber.BytesOrHex

    The body of the last update.

    - - - - - -

    Easypulse.Asset.PeripheralsEntry

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    keystring

    valuestring

    - - - - - -

    Easypulse.AssetSelection

    -

    An AssetSelection is used to select which Assets should be affected:

    - When listing Assets, it is used to determine which Assets are returned

    - When updating Assets, it is used to determine which Assets are updated

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    searchstring

    Search for assets by name, modem number, tag or notes.

    assetshiber.Filter.Modems

    Select assets by modem number.

    health_levelsstringrepeated

    Select assets by health level.

    filter_by_tagshiber.tag.TagSelection

    Select assets by tag.

    - - - - - -

    Easypulse.Fields

    -

    List the fields for the easypulse organization, to be used with the value service, for example.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    odometerEasypulse.Fields.EasypulseField

    max_rpmEasypulse.Fields.EasypulseField

    max_speedEasypulse.Fields.EasypulseField

    battery_levelEasypulse.Fields.EasypulseField

    fuel_levelEasypulse.Fields.EasypulseField

    fuel_usedEasypulse.Fields.StateBasedFields

    Fuel usage while in different states of usage.

    engine_timeEasypulse.Fields.StateBasedFields

    Time spent in different states of usage.

    engine_oil_temperatureEasypulse.Fields.EasypulseField

    pto_engagementEasypulse.Fields.PTOEngagement

    - - - - - -

    Easypulse.Fields.EasypulseField

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    fieldhiber.field.Field

    default_aggregationhiber.value.ValueAggregation

    default_transformationhiber.value.ValueTransformationoptional

    default_partitionhiber.value.Value.Numeric.DurationUnit

    target_value_durationEasypulse.TargetValues.DurationTargetValue

    target_value_distanceEasypulse.TargetValues.DistanceTargetValue

    - - - - - -

    Easypulse.Fields.PTOEngagement

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    countEasypulse.Fields.EasypulseField

    timeEasypulse.Fields.EasypulseField

    - - - - - -

    Easypulse.Fields.Request

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    organizationstring

    Pick the organization to use (/impersonate). If unset, your default organization is used.

    modemstringoptional

    Request the fields for a specific modem. -The fields are always the same, but the defaults and target values may be different.

    apply_unit_preferencesbool

    Whether to apply the unit preferences to the fields. -This will convert any fields into your preferred unit, for convenience.

    - - - - - -

    Easypulse.Fields.Response

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    fieldsEasypulse.Fields

    requestEasypulse.Fields.Request

    - - - - - -

    Easypulse.Fields.StateBasedFields

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    onEasypulse.Fields.EasypulseField

    runningEasypulse.Fields.EasypulseField

    idleEasypulse.Fields.EasypulseField

    offEasypulse.Fields.EasypulseField

    - - - - - -

    Easypulse.History

    -

    List the history for a single field, and optionally apply an aggregation and/or grouping to it.

    Deprecated in favor of the ValueService.

    - - - - - -

    Easypulse.History.Request

    -

    Request to get the history of a field, for the selected Assets in the organization.

    Deprecated in favor of the ValueService.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    organizationstring

    Pick the organization to use (/impersonate). If unset, your default organization is used.

    selectionEasypulse.AssetSelection

    Select the asset(s) to get the history for.

    paginationhiber.Pagination

    Paginate the returned values. -This may not be relevant, depending on the aggregation (which may result in a single value) and the -time range.

    time_rangehiber.TimeRange

    The time to view the history for.

    aggregationEasypulse.History.Request.Aggregation

    How to aggregate the data.

    sortEasypulse.History.Request.Sort

    split_by_durationhiber.Duration

    Split up the data in time block of the given size.

    reduce_to_max_sizeuint32

    Limit the results to the given amount of data points, applying the function to each chunk.

    fuel_levelbool

    Get the history for the fuel level.

    tire_pressurebool

    Get the history for the tire pressure.

    battery_levelbool

    Get the history for the battery level.

    temperaturebool

    Get the history for the temperature.

    run_timebool

    Get the history for the run time.

    idle_timebool

    Get the history for the idle time.

    locationbool

    Get the history for the location.

    speedbool

    Get the history for the speed.

    rpmbool

    Get the history for the rpm of the engine

    engine_statebool

    Get the history for the engine state

    fuel_efficiencybool

    Get the fuel efficiency in ???.

    distance_traveledbool

    Get the distance traveled in ???.

    odometerbool

    Get the value of the odometer. (Total traveled distance by vehicle)

    engine_runtimebool

    Get the total amount of run-time hours for the engine.

    engine_idle_timebool

    Get the total amount of idle-time hours for the engine.

    fuel_used_runningbool

    Get the total amount of fuel used by the engine while running.

    fuel_used_idlingbool

    Get the total amount of fuel used by the engine while idling.

    power_take_off_engagement_countbool

    Get the total amount of times the power take of was engaged.

    power_take_off_engagement_durationbool

    Get the total duration of time the power take of was engaged.

    engine_oil_temperaturebool

    Get the history for the engine oil temperature.

    fuel_efficiency_scorebool

    Get the normalized score for the fuel efficiency, using a preconfigured baseline.

    distance_traveled_scorebool

    Get the normalized score for the distance traveled, using a preconfigured baseline.

    idle_time_scorebool

    Get the normalized score for the idle time, using a preconfigured baseline.

    run_time_scorebool

    Get the normalized score for the run time, using a preconfigured baseline.

    utilization_scorebool

    Get the average normalized score for the run time, idle time, distance traveled and fuel efficiency.

    - - - - - -

    Easypulse.History.Response

    -

    Response with the (aggregated) history of a field, for the selected Assets in the organization.

    Deprecated in favor of the ValueService.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    valuesEasypulse.History.Response.Valuerepeated

    The processed historical data points. -For example, when applying the SUM aggregation to all data points, this list would only contains a -single value, the sum of values.

    paginationhiber.Pagination.Result

    The pagination result, containing information about amounts and pages.

    requestEasypulse.History.Request

    The request that was received, corrected and used to produce this result.

    - - - - - -

    Easypulse.History.Response.Value

    -

    Processed historical data point. If this is a group, it will have a time range to denote the group.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    timestamphiber.Timestamp

    When not grouping, time of the individual point. -When grouping would return an exact data point (i.e. not an average), the time of that point. -When grouping would not return an exact data point (i.e. average), the end of the time range.

    time_rangehiber.TimeRange

    When grouping, the start and end time for the group.

    fuel_levelfloat

    The fuel level, as a percentage.

    tire_pressure_deprecatedfloat

    Deprecated. The tire pressure in bar.

    battery_level_deprecatedfloat

    Deprecated. The battery level, as a percentage.

    temperaturefloat

    The temperature in degrees Celsius.

    run_timehiber.Duration

    The time the Asset was running.

    idle_timehiber.Duration

    The time the Asset was idle.

    locationhiber.Location

    The location of the asset at the timestamp, or the last location in the time range.

    speed_deprecatedfloat

    Deprecated. The speed of the asset in km/h.

    rpmint32

    fuel_efficiencyfloat

    Fuel efficiency in ???.

    distance_traveledfloat

    Distance traveled in ???.

    engine_stateEasypulse.EngineState

    State of the engine

    fuel_efficiency_scorefloat

    Normalized score for the fuel efficiency, using a preconfigured baseline.

    distance_traveled_scorefloat

    Normalized score for the distance traveled, using a preconfigured baseline.

    idle_time_scorefloat

    Normalized score for the idle time, using a preconfigured baseline.

    run_time_scorefloat

    Normalized score for the run time, using a preconfigured baseline.

    utilization_scorefloat

    Average normalized score for the run time, idle time, distance traveled and fuel efficiency.

    odometerhiber.value.Value.Numeric.Distance

    Current value of the odometer.

    engine_runtimehiber.Duration

    Duration of total hours the engine has ran.

    engine_idle_timehiber.Duration

    Duration of total hours the engine has been idling.

    fuel_used_runninghiber.value.Value.Numeric.Volume

    The total amount of fuel used by this vehicle.

    fuel_used_idlinghiber.value.Value.Numeric.Volume

    The total amount of fuel used by this vehicle while idling.

    power_take_off_engagement_countint32

    power_take_off_engagement_durationhiber.Duration

    engine_oil_temperaturehiber.value.Value.Numeric.Temperature

    Engine temperature.

    speedhiber.value.Value.Numeric.Speed

    Speed of the asset.

    tire_pressurehiber.value.Value.Numeric.Pressure

    The tire pressure of the asset.

    battery_levelhiber.value.Value.Numeric.BatteryLevel

    The battery level, as a percentage.

    - - - - -

    Fields with deprecated option

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameOption
    tire_pressure_deprecated

    true

    battery_level_deprecated

    true

    speed_deprecated

    true

    - - - - - -

    Easypulse.ListAssets

    -

    List the Easypulse Assets in your organization.

    Optionally, aggregated historical data can be added to the returned Assets, with a given name.

    Fails when your organizations does not have the Easypulse feature.

    - - - - - -

    Easypulse.ListAssets.Request

    -

    Request to list Assets in your organization.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    organizationstring

    Pick the organization to use (/impersonate). If unset, your default organization is used.

    selectionEasypulse.AssetSelection

    Select the Assets to return.

    paginationhiber.Pagination

    Paginate over the returned Assets.

    aggregationsEasypulse.ListAssets.Request.AggregationsEntryrepeated

    Any aggregations to return with the assets, specified as a name and a History.Request.

    sortEasypulse.ListAssets.Request.Sort

    Sort the returned assets using the given option. By default, Assets are sorted by name.

    - - - - - -

    Easypulse.ListAssets.Request.AggregationsEntry

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    keystring

    valueEasypulse.History.Request

    - - - - - -

    Easypulse.ListAssets.Response

    -

    Response with a list of Assets

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    assetsEasypulse.Assetrepeated

    The selected Assets.

    paginationhiber.Pagination.Result

    The applied pagination, including total results, page information, etc.

    requestEasypulse.ListAssets.Request

    The request that was received, corrected and used to produce this result.

    - - - - - -

    Easypulse.TargetValues

    -

    Target values for a modem.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    organizationstring

    The organization the asset is in.

    numberstring

    The asset number these target values are for.

    engine_run_timeEasypulse.TargetValues.DurationTargetValue

    engine_idle_timeEasypulse.TargetValues.DurationTargetValue

    engine_off_timeEasypulse.TargetValues.DurationTargetValue

    distance_travelledEasypulse.TargetValues.DistanceTargetValue

    availabilityEasypulse.TargetValues.DurationTargetValue

    sinarmas_specificEasypulse.TargetValues.SinarmasTargetValues

    fuel_efficiency_unitEasypulse.TargetValues.FuelEfficiencyTargetValue

    fuel_efficiency_as_volumeEasypulse.TargetValues.VolumeTargetValue

    - - - - - -

    Easypulse.TargetValues.DistanceTargetValue

    -

    A target value that measures distance per time, i.e. 12 kilometers per day.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    enabledbool

    valuefloat

    unithiber.value.Value.Numeric.Distance.Unit

    per_timehiber.value.Value.Numeric.DurationUnit

    - - - - - -

    Easypulse.TargetValues.DurationTargetValue

    -

    A target value that measures time per time, i.e. 12 hours per day.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    enabledbool

    valuefloat

    unithiber.value.Value.Numeric.DurationUnit

    per_timehiber.value.Value.Numeric.DurationUnit

    - - - - - -

    Easypulse.TargetValues.FuelEfficiencyTargetValue

    -

    A target value that measures fuel efficiency.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    enabledbool

    valuefloat

    unithiber.value.Value.Numeric.FuelEfficiency.Unit

    - - - - - -

    Easypulse.TargetValues.List

    -

    - - - - - -

    Easypulse.TargetValues.List.Request

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    organizationstring

    Pick the organization to use (/impersonate). If unset, your default organization is used.

    selectionEasypulse.AssetSelection

    Select the Assets to return.

    paginationhiber.Pagination

    Paginate over the returned Assets.

    sortEasypulse.ListAssets.Request.Sort

    Sort the returned assets using the given option. By default, Assets are sorted by name.

    apply_unit_preferencesbool

    Whether to apply the unit preferences to the fields. -This will convert any fields into your preferred unit, for convenience.

    - - - - - -

    Easypulse.TargetValues.List.Response

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    asset_target_valuesEasypulse.TargetValuesrepeated

    The selected Assets.

    paginationhiber.Pagination.Result

    The applied pagination, including total results, page information, etc.

    requestEasypulse.TargetValues.List.Request

    The request that was received, corrected and used to produce this result.

    - - - - - -

    Easypulse.TargetValues.SinarmasTargetValues

    -

    A specific set of target values for Sinarmas.

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    treesEasypulse.TargetValues.SinarmasTargetValues.TreesTargetValue

    tree_volumeEasypulse.TargetValues.SinarmasTargetValues.TreeVolumeTargetValue

    - - - - - -

    Easypulse.TargetValues.SinarmasTargetValues.TreeVolumeTargetValue

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    enabledbool

    valuefloat

    unithiber.value.Value.Numeric.Volume.Unit

    per_timehiber.value.Value.Numeric.DurationUnit

    volume_per_treefloat

    - - - - - -

    Easypulse.TargetValues.SinarmasTargetValues.TreesTargetValue

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    enabledbool

    valueuint32

    per_timehiber.value.Value.Numeric.DurationUnit

    - - - - - -

    Easypulse.TargetValues.Update

    -

    - - - - - -

    Easypulse.TargetValues.Update.Request

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    organizationstring

    Pick the organization to use (/impersonate). If unset, your default organization is used.

    numberstring

    The asset number to update the target values for.

    replace_engine_run_timeEasypulse.TargetValues.DurationTargetValue

    Replace the engine_run_time target value with this DurationTargetValue.

    replace_engine_idle_timeEasypulse.TargetValues.DurationTargetValue

    Replace the engine_idle_time target value with this DurationTargetValue.

    replace_engine_off_timeEasypulse.TargetValues.DurationTargetValue

    Replace the engine_off_time target value with this DurationTargetValue.

    replace_distance_travelledEasypulse.TargetValues.DistanceTargetValue

    Replace the distance_travelled target value with this DistanceTargetValue.

    replace_availabilityEasypulse.TargetValues.DurationTargetValue

    Replace the availability target value with this DurationTargetValue.

    replace_fuel_efficiency_unitEasypulse.TargetValues.FuelEfficiencyTargetValue

    Replace the fuel_efficiency target value with this FuelEfficiencyTargetValue.

    replace_fuel_efficiency_as_volumeEasypulse.TargetValues.VolumeTargetValue

    Replace the fuel_efficiency target value with this VolumeTargetValue.

    replace_sinarmas_specificEasypulse.TargetValues.SinarmasTargetValues

    Replace the sinarmas_specific target values with this SinarmasTargetValues.

    - - - - - -

    Easypulse.TargetValues.VolumeTargetValue

    -

    A target value that measures volume per time, i.e. 2 liters per day.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    enabledbool

    valuefloat

    unithiber.value.Value.Numeric.Volume.Unit

    per_timehiber.value.Value.Numeric.DurationUnit

    - - - - - -

    Easypulse.TellTale

    -

    A tell tale is an indicator of a part of the system.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    indicatorEasypulse.TellTale.Indicator

    namestring

    labelstring

    descriptionstring

    enum_valuehiber.value.Value.Enum

    - - - - - -

    Easypulse.TellTale.Indicator

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    stateEasypulse.TellTale.Indicator.State

    colorstring

    labelstring

    - - - - - - - -

    Easypulse.Asset.Lifecycle

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    ACCEPTANCE_TESTING0

    Modem is deployed, but not active yet. Invisible for customer.

    INSTALLED1

    Modem is active and sending messages. -See health for more details on its health, based on the past messages.

    PAUSED6

    DISABLED5

    DECOMMISSIONED4

    - -

    Easypulse.EngineState

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    OFF0

    IDLING1

    RUNNING2

    RESERVED3

    - -

    Easypulse.History.Request.Aggregation

    -

    Options to aggregate the history data points (in a group).

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    NONE0

    Do not aggregate the history data points, just list all of them.

    AVERAGE1

    Average value of all history data points (in a group).

    SUM2

    Sum all history data points (in a group).

    LAST3

    Just take the last value (in a group).

    MINIMUM4

    Take the lowest value (in a group).

    MAXIMUM5

    Take the highest value (in a group).

    - -

    Easypulse.History.Request.Sort

    -

    How to sort the returned values.

    - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    TIME_DESCENDING0

    TIME_ASCENDING1

    - -

    Easypulse.ListAssets.Request.Sort

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    NAME0

    NAME_DESC1

    LAST_UPDATED2

    INACTIVITY3

    NUMBER_ASC4

    NUMBER_DESC5

    LOWEST_FUEL_LEVEL6

    HIGHEST_FUEL_LEVEL7

    LOWEST_TIRE_PRESSURE8

    HIGHEST_TIRE_PRESSURE9

    LOWEST_BATTERY_LEVEL10

    HIGHEST_BATTERY_LEVEL11

    LOWEST_TEMPERATURE12

    HIGHEST_TEMPERATURE13

    HEALTH14

    Health sorted from least to most severe (i.e. OK, WARNING, ERROR).

    HEALTH_DESC15

    Health sorted from most to least severe (i.e. ERROR, WARNING, OK).

    HEALTH_ASC_ALPHABETICAL16

    Health sorted alphabetically by health level name.

    HEALTH_DESC_ALPHABETICAL17

    Health sorted alphabetically by health level name, descending order.

    LIFECYCLE_ASC18

    Sort modem on its Status.

    LIFECYCLE_DESC19

    Sort modem on its Status in reverse order.

    LIFECYCLE_ASC_ALPHABETICAL20

    Status sorted alphabetically by Status name.

    LIFECYCLE_DESC_ALPHABETICAL21

    Status sorted alphabetically by Status name, descending order.

    - -

    Easypulse.TellTale.Indicator.State

    -

    The state of a tell-tale sensor. Ordinal numbers follow the spec of the CAN bus for states

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    OFF0

    The tell-tale has not been triggered. This can be considered an OK state.

    RED1

    The tell-tale indicates something is very wrong with the system it is monitoring.

    YELLOW2

    The tell-tale indicates something is wrong with the system it is monitoring, but not broken yet.

    INFO3

    The tell-tale indicates there is some information about the system it is monitoring.

    NOT_AVAILABLE4

    The tell-tale sensor for this system is not available.

    OTHER5

    Other, not part of the CAN-Bus spec.

    - - - - - -

    EasypulseService

    -

    Service to list and manage Assets.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Method NameRequest TypeResponse TypeDescription
    AssetsEasypulse.ListAssets.RequestEasypulse.ListAssets.Response

    List the Easypulse Assets in your organization. -Optionally, aggregated historical data can be added to the returned Assets, with a given name. - -Fails when your organizations does not have the Easypulse feature.

    HistoryEasypulse.History.RequestEasypulse.History.Response

    List the history for a single field, and optionally apply an aggregation and/or grouping to it. -Deprecated in favor of the ValueService.

    FieldsEasypulse.Fields.RequestEasypulse.Fields.Response

    List the fields for Easypulse, so they can be used with other services.

    TargetValuesEasypulse.TargetValues.List.RequestEasypulse.TargetValues.List.Response

    Manage the target values that are used to determine score values.

    UpdateTargetValuesEasypulse.TargetValues.Update.RequestEasypulse.TargetValues

    - - - - -

    Methods with deprecated option

    - - - - - - - - - - - - - - - -
    Method NameOption
    History

    true

    - - - - -
    -

    base.proto

    Top -
    -

    - - -

    Area

    -

    Rectangular area between two locations, normalized to bottom-left and top-right points.

    Center point is added for convenience; it's simple the point directly between the two corner points.

    When sending an Area to the api, the center location is ignored.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    centerLocation

    bottom_leftLocation

    top_rightLocation

    textualstring

    Text representation. Can be used as an alternative input in a request, filled in by the API in responses.

    - - - - - -

    Avatar

    -

    An avatar is represented either by a (publicly) fetchable URL that serves an image,

    xor a binary payload that knows its name and mime-type.

    If it is a url, it must be obtainable without credentials, though this is not validated by the API.

    Because the content behind URL's can change or become unavailable over time,

    the client should make sure it properly caches the data fetched from the URL.

    ("Properly" means [among other things] respecting the response headers for this resource)

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    urlstring

    A URL that contains the location of avatar.

    imageNamedFile

    The data of the avatar as a Named File.

    - - - - - -

    BytesOrHex

    -

    Some clients may prefer direct binary data, while other prefer a hexadecimal string,

    both for input and output. To support both methods, this object is used to represent binary data.

    When you receive this from the api, both fields are set. When sending it to the api, only one field is required.

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    bytesbytes

    hexstring

    - - - - - -

    BytesOrHex.Update

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    updatedbool

    valueBytesOrHex

    - - - - - -

    Date

    -

    Date type for convenience.

    Some clients are better at parsing year, month and day of month as separate fields,

    while others prefer a text-based format.

    To accommodate this, this Date type supports both.

    When used as API output, both the int fields and textual fields will be set.

    The textual field has the commonly used ISO 8601 local date format (i.e. "2018-01-01").

    When used an API input, either specify the int fields or the textual field.

    If both are specified, the textual field will be discarded.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    yearuint32

    monthuint32

    dayuint32

    textualstring

    - - - - - -

    DoubleRange

    -

    Decimal range.

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    startdouble

    enddouble

    - - - - - -

    Duration

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    durationgoogle.protobuf.Duration

    textualstring

    - - - - - -

    Filter

    -

    Filters used in many api calls to filter the data sources, results, etc.

    "Include" fields filter out anything not in the include set.

    When not set, all items will be returned (except excluded items)

    "Exclude" fields filter out anything in the exclude set.

    When combined with include, exclude takes precedence when determining whether an item is filtered

    - - - - - -

    Filter.ChildOrganizations

    -

    Specify which organizations to get data from. By default, data is only retrieved for the current organization,

    but using ChildOrganizations we can specify to include a number of, or all, sub-organizations.

    Note: ChildOrganization differs from other filters in that it defaults to not allowing anything, where the

    other filters default to allowing everything

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    include_allbool

    includestringrepeated

    excludestringrepeated

    - - - - - -

    Filter.ChildOrganizations.Update

    -

    Update object to update a Filter.ChildOrganizations field.

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    updatedbool

    valueFilter.ChildOrganizations

    - - - - - -

    Filter.Events

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    includeEventTyperepeated

    excludeEventTyperepeated

    - - - - - -

    Filter.Events.Update

    -

    Update object to update a Filter.Events field.

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    updatedbool

    valueFilter.Events

    - - - - - -

    Filter.FieldEnumValues

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    fieldstring

    includestringrepeated

    excludestringrepeated

    - - - - - -

    Filter.HealthLevels

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    includestringrepeated

    excludestringrepeated

    - - - - - -

    Filter.ModemIdentifiers

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    includestringrepeated

    excludestringrepeated

    - - - - - -

    Filter.Modems

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    includestringrepeated

    Include all modems with these modem numbers (HEX)

    excludestringrepeated

    Exclude all modems with these modem numbers (HEX). -Exclude takes precedence over include.

    - - - - - -

    Filter.Modems.Update

    -

    Update object to update a Filter.Modems field.

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    updatedbool

    valueFilter.Modems

    - - - - - -

    Filter.OrganizationPermissions

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    include_allbool

    includeOrganizationPermissionrepeated

    excludeOrganizationPermissionrepeated

    - - - - - -

    Filter.Organizations

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    includestringrepeated

    excludestringrepeated

    - - - - - -

    Filter.Properties

    -

    Filter result on specific properties encoded in map-value pairs.

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    propertiesMapFilter

    include_only_emptybool

    When set to true, match only empty property-sets.

    - - - - - -

    Filter.Publishers

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    includeint64repeated

    excludeint64repeated

    only_activebool

    - - - - - -

    Filter.SupportPermissions

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    includeSupportPermissionrepeated

    excludeSupportPermissionrepeated

    - - - - - -

    Filter.Tags

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    includeint64repeated

    excludeint64repeated

    - - - - - -

    Filter.Tags.Update

    -

    Update object to update a Filter.Tags field.

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    updatedbool

    valueFilter.Tags

    - - - - - -

    Filter.UserPermissions

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    include_allbool

    includeUserPermissionrepeated

    excludeUserPermissionrepeated

    - - - - - -

    Filter.Users

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    includestringrepeated

    excludestringrepeated

    - - - - - -

    Filter.Webhooks

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    includeint64repeated

    excludeint64repeated

    only_activebool

    - - - - - -

    Location

    -

    Geographic latitude and longitude coordinates specified in decimal degrees.

    For more information, see the WGS-84 coordinate system, which is used for most GPS systems.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    latitudedouble

    Decimal degrees north.

    longitudedouble

    Decimal degrees east.

    textualstring

    Text representation. Can be used as an alternative input in a request, filled in by the API in responses.

    - - - - - -

    LocationSelection

    -

    Selection object for map data. Filter modems on the map by id, (child)organization.

    Also, filter the map data by level and area restriction, to only display a small area at a detailed map level,

    for example

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    areasArearepeated

    Rectangular areas, each defined by two locations, normalized to bottom-left and top-right points.

    shapesShaperepeated

    Polygon shapes, each defined by a list of locations, which draw a shape on the map.

    - - - - - -

    MapFilter

    -

    Some properties are stored as a name-value pair (e.g. bluetooth: 4.0, bluetooth: BLE).

    This filter allows selecting a range of values for a specific name.

    One could imagine wanting to include "all devices with bluetooth 4.0 or 4.1".

    To select for multiple versions of a property,

    add the name of the property as a map-key and add a repeated list of versions as the map-value.

    For example:

    - include { 'bluetooth' -> [ ] }

    returns all items that have any version of bluetooth,

    - include { 'bluetooth' -> [ '4.0', '5.0' ] }

    will only return items that have bluetooth version 4.0 _or_ 5.0 (inclusive or),

    - include { 'bluetooth' -> [ '' ] }

    would only select bluetooth peripherals that don't have any version set,

    - include { 'bluetooth' -> [ ], 'LoRaWAN' -> [ ] }

    will only select items that have both bluetooth (any version) _and_ LoRaWAN (any version),

    - include { 'bluetooth' -> [ ] }, exclude { 'bluetooth' -> [ ] }

    will return an empty list since exclude will take precedence, and

    - include { 'bluetooth' -> [ ] }, exclude { 'bluetooth' -> [ '3.0' ] }

    returns only items that have bluetooth, but not version 3.0.

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    include_andMapFilter.IncludeAndEntryrepeated

    Filter to only include items with all of the given set of properties.

    excludeMapFilter.ExcludeEntryrepeated

    Filter to exclude items with any of the given set of properties.

    - - - - - -

    MapFilter.ExcludeEntry

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    keystring

    valueMapFilter.OneOfValues

    - - - - - -

    MapFilter.IncludeAndEntry

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    keystring

    valueMapFilter.OneOfValues

    - - - - - -

    MapFilter.OneOfValues

    -

    Technical solution to make map into a map,

    which is not possible in protobuf without trickery.

    - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    valuestringrepeated

    - - - - - -

    NamedFile

    -

    A NamedFile contains bytes with its mime-type and name.

    It can represent any file of any type.

    Note that depending on where in the API this is used,

    the server might put restrictions on file size, media-type or name length.

    The file name should be interpreted as-is.

    No hierarchical information is stored in the name, nor should you look at the "extension" to know its media-type.

    It might not even have a file extension.

    The file name may contain characters that cannot be a valid file name on certain systems.

    Specific API calls may pur restrictions on the name or size of the file.

    When showing this as an image in a browser, one can make use of a `data` URI.

    The client must convert the bytes to base64 and can then construct a data URI like this

    data:;base64,

    Other type clients should be able to sort-of-directly set the data bytes as the source for an image.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    dataBytesOrHex

    The binary payload that represents the file

    media_typestring

    The media-type of the file, as defined by RFC 6838 or its extensions

    namestring

    A semantic name for this file.

    - - - - - -

    Pagination

    -

    Pagination is normalized across the api. Provide a pagination object to get a specific page or offset,

    or limit your data.

    Calls that have a pagination option automatically return a Pagination.Result, which contains

    either the specified pagination options or the defaults, as well as total counts. It also contains Pagination

    objects that can be used for the previous and next page.

    This effectively means that an api user would never need to create their own pagination object; as long as they

    start at the first page and continue to the next, they can use the provided Pagination object.

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    sizeint32

    pageint32

    - - - - - -

    Pagination.Result

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    sizeint32

    pageint32

    totalint32

    total_pagesint32

    previousPagination

    nextPagination

    approximated_totalbool

    Indicates that the total is an approximation, and not an exact value. -This can be set for data that changes often, or is generally only fetched in an infinite scrolling manner. -For example, unbundled events are likely to return an approximated total, but not guaranteed to do so.

    - - - - - -

    Shape

    -

    Polygon shape defined by a list of locations, which draw a shape on the map.

    The last point is connected to the first to close the shape.

    For example, the outline of a city would be defined using a Shape,

    while a rectangular region is easier to define using Area.

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    pathLocationrepeated

    textualstring

    Text representation. Can be used as an alternative input in a request, filled in by the API in responses.

    - - - - - -

    TimeRange

    -

    Period of time between two timestamps. Typically used for filtering.

    This can be used with textual shortcuts for timestamp, and some additional duration textual shortcuts:

    - a duration as an offset of now, i.e. "-10h" or "PT-10h": converted to now + offset, so start.textual -10h is

    10 hours before the end time (using the ISO 8601 duration format)

    Examples:

    - start "-10h" end "now": a time range from 10 hours before the request time, to the request time

    - start "-10h" end "2022-01-01 20:00": becomes start 2022-01-01 10:00 end 2022-01-01 20:00

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    startTimestamp

    endTimestamp

    - - - - - -

    Timestamp

    -

    Timestamp type for convenience.

    Some clients are better at parsing Google's seconds/nanos based timestamp, while others prefer a text-based format.

    To accommodate this, this Timestamp type supports both.

    When used as API output, both the timestamp and textual fields will be set. The textual field has the commonly

    used ISO 8601 format (i.e. "2018-01-01T13:00:00Z").

    When used an API input, only one of the fields is needed, there is no need to set both. When both are set, the

    timestamp field will be used, the textual field will be discarded.

    In addition, the textual field, when used as input, allows for a number of shortcuts that get converted into

    timestamps:

    - "now": converted to the current timestamp at the time of the request

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    timestampgoogle.protobuf.Timestamp

    time_zonestring

    textualstring

    - - - - - -

    UpdateBoolean

    -

    Update object for a boolean.

    Since false is the default value, we need to distinguish between an omitted value and setting the value to false,

    in an update object.

    To use this to update, set a value and set updated to true

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    updatedbool

    valuebool

    - - - - - -

    UpdateClearableString

    -

    Update object for a string that can be empty.

    Since an empty string is also the default value, we need to distinguish between an omitted value and

    setting the value to an empty string, in an update object.

    To use this to update, set a value and set updated to true

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    updatedbool

    valuestring

    - - - - - -

    UpdateOptionalDuration

    -

    Update object for an optional Duration.

    To use this to update, set a value and set updated to true.

    To clear the duration, set updated to true, but set no value.

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    updatedbool

    valueDuration

    - - - - - -

    UpdateOptionalId

    -

    Update object for an optional id.

    To use this to update, set a value and set updated to true. To clear the id, set updated to true, but set no value.

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    updatedbool

    valueint64

    - - - - - -

    UpdateZeroableInt

    -

    Update object for an int that can be set to 0.

    Since 0 is also the default value, we need to distinguish between an omitted value and setting the value to 0,

    in an update object.

    To use this to update, set a value and set updated to true

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    updatedbool

    valueuint32

    - - - - - - - -

    EventType

    -

    Enum of api-accessible events.

    The event types in this enum have a protobuf implementation, and can be used, for example, in the

    api event stream and publishers.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    DEFAULT0

    ORGANIZATION_CREATED34

    ORGANIZATION_UPDATED12

    ORGANIZATION_DELETED35

    ORGANIZATION_EVENT_CONFIGURATION_UPDATED43

    MODEM_CREATED55

    MODEM_UPDATED36

    MODEM_LOCATION_UPDATED4

    MODEM_ACTIVATED33

    MODEM_MESSAGE_RECEIVED5

    MODEM_MESSAGE_BODY_PARSED39

    MODEM_MESSAGE_BODY_RECEIVED45

    MODEM_MESSAGE_CANNOT_BE_PARSED15

    MODEM_MESSAGE_SUMMARY42

    MODEM_MESSAGE_BODY_PARSER_CREATED46

    MODEM_MESSAGE_BODY_PARSER_UPDATED47

    MODEM_MESSAGE_BODY_PARSER_DELETED48

    MODEM_ALARM56

    MODEM_ALARM_CREATED57

    MODEM_ALARM_UPDATED58

    MODEM_ALARM_DELETED59

    ASSIGNED63

    UNASSIGNED64

    MODEM_TRANSFER_STARTED17

    MODEM_TRANSFER_RECEIVED18

    MODEM_TRANSFER_CANCELLED19

    MODEM_TRANSFER_NOT_RECEIVED20

    MODEM_TRANSFER_RETURN_TRANSFER_STARTED21

    PUBLISHER_CREATED1

    PUBLISHER_UPDATED2

    PUBLISHER_DELETED3

    PUBLISHER_AUTO_DISABLED37

    PUBLISHER_FAILED11

    USER_ACCESS_REQUEST8

    USER_INVITED38

    USER_ADDED9

    USER_REMOVED10

    USER_VALIDATION_UPDATED54

    TOKEN_CREATED31

    TOKEN_EXPIRY_WARNING25

    TOKEN_EXPIRED26

    TOKEN_DELETED32

    EXPORT_CREATED65

    EXPORT_READY66

    EXPORT_FAILED67

    - -

    Health

    -

    Health is an indicator for issues. It is used for publishers to give a quick indication of issues.

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    OK0

    WARNING1

    ERROR2

    - -

    UnitOfMeasurement

    -

    Unit of measurement for a numeric value.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    UNIT_UNKNOWN0

    DURATION_MILLISECONDS40

    DURATION_SECONDS1

    DURATION_MINUTES2

    DURATION_HOURS3

    DURATION_DAYS4

    DURATION_WEEKS41

    FUEL_EFFICIENCY_LITER_PER_100_KILOMETER30

    FUEL_EFFICIENCY_KILOMETER_PER_LITER31

    FUEL_EFFICIENCY_KILOMETER_PER_US_GALLON32

    FUEL_EFFICIENCY_KILOMETER_PER_IMPERIAL_GALLON33

    FUEL_EFFICIENCY_MILE_PER_US_GALLON34

    FUEL_EFFICIENCY_MILE_PER_IMPERIAL_GALLON35

    FUEL_EFFICIENCY_MILE_PER_LITER36

    DISTANCE_METER8

    DISTANCE_MILLIMETER9

    DISTANCE_CENTIMETER10

    DISTANCE_KILOMETER11

    DISTANCE_NAUTICAL_MILE26

    DISTANCE_MILE21

    DISTANCE_YARD27

    DISTANCE_FOOT28

    DISTANCE_INCH29

    PERCENT16

    PRESSURE_BAR12

    PRESSURE_PSI14

    PRESSURE_K_PA17

    SPEED_KILOMETERS_PER_HOUR18

    SPEED_KNOTS19

    SPEED_METERS_PER_SECOND20

    SPEED_MILES_PER_HOUR22

    TEMPERATURE_KELVIN5

    TEMPERATURE_DEGREES_CELSIUS6

    TEMPERATURE_DEGREES_FAHRENHEIT7

    VOLTAGE_MILLIVOLT15

    VOLUME_LITER23

    VOLUME_GALLON_US24

    VOLUME_GALLON_IMPERIAL25

    VOLUME_CUBIC_METER42

    VOLUME_CUBIC_FOOT43

    MASS_KILOGRAMS37

    MASS_POUNDS38

    FLOW_CUBIC_METERS_PER_HOUR39

    REVOLUTIONS_PER_MINUTE44

    ITEMS_PER_24_HOURS45

    - - - - - - - -
    -

    field.proto

    Top -
    -

    - - -

    Field

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    identifierstring

    Unique identifier for this field.

    fieldstring

    The name of the field (if in the root structure) or a JsonPath to the field.

    display_namestring

    An optional display name for the field.

    priorityint32

    Priority of the field, typically used for ordering.

    typehiber.value.Value.Type

    The type of value the field contains.

    numericField.Numeric

    enumField.Enum

    encryptedbool

    Whether this field should be stored encrypted or not. -If it is, some processing options may be unavailable or slower.

    optionalbool

    Whether this field should be validated from the parser output.

    unit_of_measurementhiber.UnitOfMeasurement

    Deprecated. If numeric, the unit of the field. -Deprecated: use numeric.numeric_unit oneof instead

    unit_symbolstring

    Deprecated. The symbol for the unit. -Deprecated: use numeric.symbol instead

    - - - - -

    Fields with deprecated option

    - - - - - - - - - - - - - - - - - - - - -
    NameOption
    unit_of_measurement

    true

    unit_symbol

    true

    - - - - - -

    Field.Enum

    -

    If the field is an enum, this specifies the enum values for the field.

    - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    valueshiber.value.Value.Enumrepeated

    - - - - - -

    Field.Numeric

    -

    If the field is numeric, this specifies the unit and formatting details for the field.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    typehiber.value.Value.Numeric.Type

    The type of numeric value.

    symbolstring

    The symbol to use for the field's unit.

    formatField.Numeric.Format

    How to format the values (number of decimals, rounding, etc.).

    unitField.Numeric.Unit

    The unit for the field, depending on the type.

    converted_fromField.Numeric.Unit

    If the unit preferences were applied, and the unit is different, the field will be converted to the preferred -unit, from the original unit specified in this field.

    - - - - - -

    Field.Numeric.Format

    -

    Formatting options for the field.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    round_to_integerbool

    Round to an integer.

    round_to_scaleuint32

    Round to a number of decimals (at least 1).

    rounding_modeField.Numeric.Format.RoundingMode

    How to round the value when scale is applied.

    - - - - - -

    Field.Numeric.Unit

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    battery_levelhiber.value.Value.Numeric.BatteryLevel.Unit

    distancehiber.value.Value.Numeric.Distance.Unit

    durationhiber.value.Value.Numeric.DurationUnit

    fuel_efficiencyhiber.value.Value.Numeric.FuelEfficiency.Unit

    flowhiber.value.Value.Numeric.Flow.Unit

    percentagehiber.value.Value.Numeric.Percentage.Unit

    pressurehiber.value.Value.Numeric.Pressure.Unit

    speedhiber.value.Value.Numeric.Speed.Unit

    temperaturehiber.value.Value.Numeric.Temperature.Unit

    voltagehiber.value.Value.Numeric.Voltage.Unit

    volumehiber.value.Value.Numeric.Volume.Unit

    masshiber.value.Value.Numeric.Mass.Unit

    rotation_speedhiber.value.Value.Numeric.RotationSpeed.Unit

    ratehiber.value.Value.Numeric.Rate.Unit

    - - - - - - - -

    Field.Numeric.Format.RoundingMode

    -

    How to round the value when scale is applied.

    For example, a value of 3.1415 with scale 3 could be

    4.141 (DOWN, HALF_DOWN, FLOOR) or

    4.142 (HALF_UP, UP, CEILING).

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    HALF_UP0

    Round towards "nearest neighbor" unless both neighbors are equidistant, in which case round up -Effectively round up when >= .5, otherwise round down.

    HALF_DOWN1

    Round towards "nearest neighbor" unless both neighbors are equidistant, in which case round down. -Effectively round up when > .5, otherwise round down.

    UP3

    Round away from zero: 1.1 -> 2, while -1.1 -> -2.

    DOWN4

    Round towards zero: 1.1 -> 1, while -1.1 -> -1.

    CEILING5

    Round towards positive infinity.

    FLOOR6

    Round towards negative infinity.

    HALF_EVEN7

    Round towards the "nearest neighbor" unless both neighbors are equidistant, in which case, -round towards the even neighbor. -Effectively round up when >= .5 and next integer value is even, otherwise round down.

    - - - - - - - -
    -

    health.proto

    Top -
    -

    - - -

    AddHealthLevel

    -

    - - - - - -

    AddHealthLevel.Request

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    organizationstring

    Pick the organization to use (/impersonate). If unset, your default organization is used.

    new_health_levelHealthLevel

    Add the given level to the organizations health levels. -The new health level will be added with the highest severity (at the bottom of the health levels list).

    - - - - - -

    AddHealthLevel.Response

    -

    - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    health_levelsHealthLevelrepeated

    - - - - - -

    HealthLevel

    -

    A health level in an organization.

    Health can be customized depending on your need.

    The default health levels are:

    - OK (green): no problems detected

    - WARNING (orange): unresolvable problems detected, for example delayed or skipped messages

    - ERROR (red): significant problems detected (that typically can be resolved),

    for example inactivity or invalid messages (resolved on a successful message)

    Health levels can be customized to as many as you need for your operations, for example:

    - INTERVENTION

    - DEFECT

    - BATTERY

    - HIGH

    - LOW

    Health levels are ordered by severity (low to high),

    and of all things affecting a modem's health,

    only the most severe level will be returned when retrieving a modem.

    Health can be assigned using modems alarms, which specify the health level they will cause on a modem (and for how

    long, if it does not resolve automatically).

    Precisely one health level can be assigned as a catch-all for any unknown health levels from alarms (or Hiber systems),

    which can happen when a device manufacturer has provided alarms to your device (e.g. a low battery alarm).

    By default, any unknown health levels map to the level that is marked catch-all.

    Health level have a set of named colors, represented by a map where the key is the name of the color

    and the value is a string that represents a valid CSS3 color.

    Simple examples are: green, red, orange, grey, #FF00FF for fuchsia, etc (Keep in mind that CSS3 allows for many

    ways to define colors, see https://www.w3.org/TR/2003/WD-css3-color-20030214/).

    All the following definitions also mean "red":

    - rgb(255, 0, 0)

    - rgb(100%, 0, 0)

    - rgba(100%, 0%, 0%, 100%)

    - hsl(0, 100%, 50%)

    - hsla(0, 100%, 50%, 1)

    The client is responsible for rendering the correct color from the CSS3 color-space and for setting the colors and

    their names. There is no verification on missing named colors, so the client must set sensible defaults when colors

    are missing.

    To assist with sorting, health levels have a numeric severity equal to their index in the sorted list of health

    levels (starting at 1). This means higher numbers denote a more severe health.

    Since these values are noting more than a list index, they should not be cached, compared to another organization or

    compared to values retrieved from the API at another time.

    For example, an organization using the default health would have:

    - Ok: severity 1

    - Warning: severity 2

    - Error: severity 3

    That organization could then add a new health level in between Ok and Warning, meaning the severity of Warning and

    Error will change:

    - Ok, severity 1

    - ItsComplicated, severity 2

    - Warning, severity 3

    - Error, severity 4

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    levelstring

    The name of this health level. -Levels are identified by their name. -The API does support renaming, where the rename is propagated to all the relevant parts of the system.

    colorstring

    Deprecated. Default color for the health level, as a string that represents a valid CSS3 color. -DEPRECATED: Maps to the color named "text" in color_data.

    color_dataHealthLevel.ColorDataEntryrepeated

    Map of named colors, where key is the name and the value is a valid CSS3 color definition.

    severityint64

    A unique numeric value equal to the index of this health level in the list of health levels sorted by ascending severity (starting at 1). -This means higher numbers denote a more severe health. -This value cannot be used when creating or updating. -To change the severity for a health level, reorder all health levels.

    catch_allbool

    Precisely one health level can be assigned as a catch-all for any unknown health levels from alarms (or Hiber systems), -which can happen when a device manufacturer has provided alarms for your device (e.g. a low battery alarm). -By default, unknown health levels map to the level of the highest severity, -unless another level is marked as catch-all.

    - - - - -

    Fields with deprecated option

    - - - - - - - - - - - - - - - -
    NameOption
    color

    true

    - - - - - -

    HealthLevel.ColorDataEntry

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    keystring

    valuestring

    - - - - - -

    HealthLevelSelection

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    searchstring

    Search for the given string in the levels and colors.

    levelsstringrepeated

    Filter by exact levels.

    - - - - - -

    ListHealthLevels

    -

    - - - - - -

    ListHealthLevels.Request

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    organizationstring

    Pick the organization to use (/impersonate). If unset, your default organization is used.

    selectionHealthLevelSelection

    - - - - - -

    ListHealthLevels.Response

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    health_levelsHealthLevelrepeated

    requestListHealthLevels.Request

    - - - - - -

    RemoveHealthLevel

    -

    - - - - - -

    RemoveHealthLevel.Request

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    organizationstring

    Pick the organization to use (/impersonate). If unset, your default organization is used.

    levelstring

    - - - - - -

    RemoveHealthLevel.Response

    -

    - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    health_levelsHealthLevelrepeated

    - - - - - -

    ReorderHealthLevels

    -

    Re-order the health levels for your organization.

    - - - - - -

    ReorderHealthLevels.Request

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    organizationstring

    Pick the organization to use (/impersonate). If unset, your default organization is used.

    levelsstringrepeated

    The health levels for the organization, ordered by severity (low to high). -This list must include _all_ health levels, or the call will fail. -The implication is, that if someone adds, removes or renames a level just before this call is sent, -then this call will fail to protect against strange results.

    - - - - - -

    ReorderHealthLevels.Response

    -

    - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    reordered_health_levelsHealthLevelrepeated

    - - - - - -

    UpdateHealthLevel

    -

    - - - - - -

    UpdateHealthLevel.Request

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    organizationstring

    Pick the organization to use (/impersonate). If unset, your default organization is used.

    levelstring

    renamestring

    Optionally, rename this health level. -NOTE! Don't use this to change the semantics of a health level. -All historic events that have this health-level will change with it. -(Unless you are very sure you want to change history, that is)

    update_colorhiber.UpdateClearableString

    Deprecated. Optionally, set or update the color for this health level. -DEPRECATED, use add_colors with name "text". -Vice versa, this field will also update the "text" color in the color_data field of HealthLevel.

    remove_colorsstringrepeated

    Remove colors by name. Will remove the named color from the color_data field in HealthLevel.

    add_colorsUpdateHealthLevel.Request.AddColorsEntryrepeated

    Add colors by name. Will add the named color from the color_data field in HealthLevel. -For backwards compatibility reasons, if add_colors contains a color named "text", it will also update -the field color in HealthLevel

    update_catch_allhiber.UpdateBoolean

    Optionally, set or unset the catch all flag.

    - - - - -

    Fields with deprecated option

    - - - - - - - - - - - - - - - -
    NameOption
    update_color

    true

    - - - - - -

    UpdateHealthLevel.Request.AddColorsEntry

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    keystring

    valuestring

    - - - - - -

    UpdateHealthLevel.Response

    -

    - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    health_levelsHealthLevelrepeated

    - - - - - - - - - - - -

    HealthService

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Method NameRequest TypeResponse TypeDescription
    ListListHealthLevels.RequestListHealthLevels.Response

    List the health levels.

    ReorderReorderHealthLevels.RequestReorderHealthLevels.Response

    Reorder the health levels, changing the order of severity.

    AddAddHealthLevel.RequestAddHealthLevel.Response

    Add a new health level at the end of the list (highest severity).

    UpdateUpdateHealthLevel.RequestUpdateHealthLevel.Response

    Update or rename a health level.

    RemoveRemoveHealthLevel.RequestRemoveHealthLevel.Response

    Remove a health level. Any events with that level are redirected to the catch-all level.

    - - - - -
    -

    tag.proto

    Top -
    -

    - - -

    CreateTagRequest

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    organizationstring

    Pick the organization to use (/impersonate). If unset, your default organization is used.

    createTag.Label

    - - - - - -

    DeleteTagRequest

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    organizationstring

    Pick the organization to use (/impersonate). If unset, your default organization is used.

    idint64

    - - - - - -

    DeleteTagRequest.Response

    -

    - - - - - -

    ListTagsRequest

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    organizationstring

    Pick the organization to use (/impersonate). If unset, your default organization is used.

    selectionTagSelection

    modem_countbool

    webhook_countbool

    - - - - - -

    ListTagsRequest.Response

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    tagsTagrepeated

    requestListTagsRequest

    tag_modem_countListTagsRequest.Response.TagModemCountEntryrepeated

    map<tag-id, count>

    tag_webhook_countListTagsRequest.Response.TagWebhookCountEntryrepeated

    map<webhook-id, count>

    - - - - - -

    ListTagsRequest.Response.TagModemCountEntry

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    keyint64

    valueint32

    - - - - - -

    ListTagsRequest.Response.TagWebhookCountEntry

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    keyint64

    valueint32

    - - - - - -

    Tag

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    idint64

    labelTag.Label

    - - - - - -

    Tag.Label

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    namestring

    typestring

    - - - - - -

    TagSelection

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    searchstringrepeated

    namesstringrepeated

    filterhiber.Filter.Tags

    typesstringrepeated

    - - - - - -

    UpdateTagRequest

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    organizationstring

    Pick the organization to use (/impersonate). If unset, your default organization is used.

    idint64

    updateTag.Label

    - - - - - -

    UpdateTagsForItem

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    tag_ids_to_addint64repeated

    tag_ids_to_removeint64repeated

    new_tags_to_addTag.Labelrepeated

    - - - - - - - - - - - -

    TagService

    -

    Tag management api calls. You can already get tags for objects when you get their data, and even create new tags

    when updating them, so these calls are meant for easier tag management if you need it.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Method NameRequest TypeResponse TypeDescription
    ListListTagsRequestListTagsRequest.Response

    CreateCreateTagRequestTag

    UpdateUpdateTagRequestTag

    DeleteDeleteTagRequestDeleteTagRequest.Response

    - - - - -
    -

    value.proto

    Top -
    -

    - - -

    Value

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    typeValue.Type

    numericValue.Numeric

    textstring

    enumValue.Enum

    - - - - - -

    Value.Enum

    -

    If this value is an enum, this specifies the value, display name and color for this enum value.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    valuestring

    The enum value. This might be a cryptic value, see the display_name and description for more information.

    display_namestring

    User-facing name for this value.

    descriptionstring

    More details for this enum value.

    colorstring

    (Optional) color for this enum value.

    priorityint32

    Priority of the value, typically used for ordering.

    - - - - - -

    Value.Numeric

    -

    If the value is numeric, this specifies the unit, value, etc.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    typeValue.Numeric.Type

    battery_levelValue.Numeric.BatteryLevel

    distanceValue.Numeric.Distance

    durationhiber.Duration

    fuel_efficiencyValue.Numeric.FuelEfficiency

    percentageValue.Numeric.Percentage

    pressureValue.Numeric.Pressure

    speedValue.Numeric.Speed

    temperatureValue.Numeric.Temperature

    voltageValue.Numeric.Voltage

    volumeValue.Numeric.Volume

    massValue.Numeric.Mass

    flowValue.Numeric.Flow

    rotation_speedValue.Numeric.RotationSpeed

    rateValue.Numeric.Rate

    unknowndouble

    - - - - - -

    Value.Numeric.BatteryLevel

    -

    Special case for battery level, since it can be provided in many units.

    Not included in the UnitPreferences, since it cannot be converted.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    valuedouble

    unitValue.Numeric.BatteryLevel.Unit

    textualstring

    Textual representation including unit symbol, rounded based on the user preferences and field config.

    converted_fromValue.Numeric.BatteryLevel.Unit

    The original unit, iff this value was converted from another unit because of user preferences.

    - - - - - -

    Value.Numeric.Distance

    -

    The value is a distance value, converted to your preferred distance unit.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    valuedouble

    unitValue.Numeric.Distance.Unit

    textualstring

    Textual representation including unit symbol, rounded based on the user preferences and field config.

    converted_fromValue.Numeric.Distance.Unit

    The original unit, iff this value was converted from another unit because of user preferences.

    - - - - - -

    Value.Numeric.Flow

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    valuedouble

    unitValue.Numeric.Flow.Unit

    textualstring

    Textual representation including unit symbol, rounded based on the user preferences and field config.

    converted_fromValue.Numeric.Flow.Unit

    The original unit, iff this value was converted from another unit because of user preferences.

    - - - - - -

    Value.Numeric.FuelEfficiency

    -

    The value is a distance value, converted to your preferred distance unit.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    valuedouble

    unitValue.Numeric.FuelEfficiency.Unit

    textualstring

    Textual representation including unit symbol, rounded based on the user preferences and field config.

    converted_fromValue.Numeric.FuelEfficiency.Unit

    The original unit, iff this value was converted from another unit because of user preferences.

    - - - - - -

    Value.Numeric.Mass

    -

    The value is a volume value, converted to your preferred volume unit.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    valuedouble

    unitValue.Numeric.Mass.Unit

    textualstring

    Textual representation including unit symbol, rounded based on the user preferences and field config.

    converted_fromValue.Numeric.Mass.Unit

    The original unit, iff this value was converted from another unit because of user preferences.

    - - - - - -

    Value.Numeric.Percentage

    -

    The value is a percentage.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    valuefloat

    unitValue.Numeric.Percentage.Unit

    textualstring

    Textual representation with % symbol, rounded based on the user preferences and field config.

    - - - - - -

    Value.Numeric.Pressure

    -

    The value is a pressure value, converted to your preferred pressure unit.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    valuedouble

    unitValue.Numeric.Pressure.Unit

    textualstring

    Textual representation including unit symbol, rounded based on the user preferences and field config.

    converted_fromValue.Numeric.Pressure.Unit

    The original unit, iff this value was converted from another unit because of user preferences.

    - - - - - -

    Value.Numeric.Rate

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    valueuint32

    unitValue.Numeric.Rate.Unit

    textualstring

    Textual representation including unit symbol, rounded based on the user preferences and field config.

    converted_fromValue.Numeric.Rate.Unit

    The original unit, iff this value was converted from another unit because of user preferences.

    - - - - - -

    Value.Numeric.RotationSpeed

    -

    The value for rotation speed. The only value is revolutions per minute (RPM), therefore it is not included in

    unit preferences.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    valuedouble

    unitValue.Numeric.RotationSpeed.Unit

    textualstring

    Textual representation including unit symbol, rounded based on the user preferences and field config.

    converted_fromValue.Numeric.RotationSpeed.Unit

    The original unit, iff this value was converted from another unit because of user preferences.

    - - - - - -

    Value.Numeric.Speed

    -

    The value is a speed value, converted to your preferred speed unit.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    valuedouble

    unitValue.Numeric.Speed.Unit

    textualstring

    Textual representation including unit symbol, rounded based on the user preferences and field config.

    converted_fromValue.Numeric.Speed.Unit

    The original unit, iff this value was converted from another unit because of user preferences.

    - - - - - -

    Value.Numeric.Temperature

    -

    The value is a temperature, converted to your preferred temperature unit.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    valuedouble

    unitValue.Numeric.Temperature.Unit

    textualstring

    Textual representation including unit symbol, rounded based on the user preferences and field config.

    converted_fromValue.Numeric.Temperature.Unit

    The original unit, iff this value was converted from another unit because of user preferences.

    - - - - - -

    Value.Numeric.Voltage

    -

    The value is a voltage, converted to your preferred voltage unit.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    valuedouble

    unitValue.Numeric.Voltage.Unit

    textualstring

    Textual representation including unit symbol, rounded based on the user preferences and field config.

    converted_fromValue.Numeric.Voltage.Unit

    The original unit, iff this value was converted from another unit because of user preferences.

    - - - - - -

    Value.Numeric.Volume

    -

    The value is a volume value, converted to your preferred volume unit.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    valuedouble

    unitValue.Numeric.Volume.Unit

    textualstring

    Textual representation including unit symbol, rounded based on the user preferences and field config.

    converted_fromValue.Numeric.Volume.Unit

    The original unit, iff this value was converted from another unit because of user preferences.

    - - - - - - - -

    Value.Numeric.BatteryLevel.Unit

    -

    other units will be added here later, like voltage

    - - - - - - - - - - - - - -
    NameNumberDescription
    PERCENT0

    Battery level as a percentage (technically not a unit).

    - -

    Value.Numeric.Distance.Unit

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    METER0

    MILLIMETER1

    CENTIMETER2

    KILOMETER3

    YARD5

    MILE4

    FOOT6

    INCH7

    NAUTICAL_MILE8

    This is a special case unit and may not be auto-converted to your UnitPreference.

    - -

    Value.Numeric.DurationUnit

    -

    The duration enum is not wrapped in Duration, since duration is always returned as a normalize Duration.

    This unit is still used for fields, however.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    MILLISECONDS0

    SECONDS1

    MINUTES2

    HOURS3

    DAYS4

    WEEKS5

    - -

    Value.Numeric.Flow.Unit

    -

    - - - - - - - - - - - - - -
    NameNumberDescription
    CUBIC_METER_PER_HOUR0

    - -

    Value.Numeric.FuelEfficiency.Unit

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    LITER_PER_100_KILOMETER0

    KILOMETER_PER_LITER1

    KILOMETER_PER_GALLON2

    KILOMETER_PER_IMPERIAL_GALLON3

    MILE_PER_GALLON4

    MILE_PER_IMPERIAL_GALLON5

    MILE_PER_LITER6

    - -

    Value.Numeric.Mass.Unit

    -

    - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    KILOGRAMS0

    POUNDS1

    - -

    Value.Numeric.Percentage.Unit

    -

    - - - - - - - - - - - - - -
    NameNumberDescription
    PERCENT0

    Technically not a unit, but for consistency, we've added it here.

    - -

    Value.Numeric.Pressure.Unit

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    BAR0

    PSI1

    K_PA2

    - -

    Value.Numeric.Rate.Unit

    -

    - - - - - - - - - - - - - -
    NameNumberDescription
    ITEMS_PER_24_HOURS0

    The amount of items counted in a 24 hour window.

    - -

    Value.Numeric.RotationSpeed.Unit

    -

    - - - - - - - - - - - - - -
    NameNumberDescription
    REVOLUTIONS_PER_MINUTE0

    - -

    Value.Numeric.Speed.Unit

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    KILOMETERS_PER_HOUR0

    KNOTS1

    This is a special case unit and may not be auto-converted to your UnitPreference.

    METERS_PER_SECOND2

    MILES_PER_HOUR3

    - -

    Value.Numeric.Temperature.Unit

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    KELVIN0

    DEGREES_CELSIUS1

    DEGREES_FAHRENHEIT2

    - -

    Value.Numeric.Type

    -

    The type of numeric value that is represented.

    Supported types will automatically convert to the preferred unit (based on the user settings).

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    TYPE_UNKNOWN0

    PERCENTAGE1

    TEMPERATURE2

    DISTANCE3

    PRESSURE4

    VOLTAGE5

    SPEED6

    VOLUME7

    DURATION8

    FUEL_EFFICIENCY9

    MASS10

    BATTERY_LEVEL11

    FLOW12

    ROTATION_SPEED13

    RATE14

    - -

    Value.Numeric.Voltage.Unit

    -

    - - - - - - - - - - - - - -
    NameNumberDescription
    MILLIVOLT0

    - -

    Value.Numeric.Volume.Unit

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    LITER0

    GALLON_US1

    GALLON_IMPERIAL2

    CUBIC_METER3

    CUBIC_FEET4

    - -

    Value.Type

    -

    The type of value that is represented.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    OTHER0

    NUMERIC1

    This field contains numeric values, with an optional unit of measurement defined below.

    TEXT2

    This field contains text to be displayed.

    ENUM3

    This field switches between several predefined values. Typically used for status fields.

    - -

    ValueAggregation

    -

    Get the values for the selected field.

    There are a few limitations here:

    - text fields can only use the LAST aggregation.

    - enum fields support a subset of aggregations:

    - DEFAULT and LAST return the last value.

    - MINIMUM and MAXIMUM return the lowest or highest value (respectively) based on the enum value order.

    - AVERAGE and SUM are not supported.

    - enum duration

    An enum example:

    Field "status" with this timeline: 00:00 OK, 00:10 FAILED, 00:20 OK, 00:25 FAILED, 00:40 OK

    - aggregation DEFAULT or LAST: OK, since it's OK at the end of the time range.

    - aggregation SUM: OK: 35m, FAILED: 25m

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    DEFAULT0

    AVERAGE1

    Return the average value. -Not supported for textual and enum fields. When used with these fields, LAST is used instead.

    SUM2

    Return the sum all values. -Not supported for textual and enum fields. When used with these fields, LAST is used instead.

    LAST3

    Just take the last value.

    MINIMUM4

    Return the lowest value. -For enum fields, the order of values is used to determine the MINIMUM. -Not supported for textual fields. When used with these fields, LAST is used instead.

    MAXIMUM5

    Return the highest value. -For enum fields, the order of values is used to determine the MAXIMUM. -Not supported for textual fields. When used with these fields, LAST is used instead.

    - -

    ValueTransformation

    -

    Transform the values into a derived value.

    - - - - - - - - - - - - - - - - - - - -
    NameNumberDescription
    DURATION0

    Instead of returning the value, return the amount of time a value was active. -Aggregation (if applicable) is applied afterwards on the duration value.

    DELTA1

    Instead of returning the value, return the difference between the value and the previous value. -Aggregation (if applicable) is applied before the delta is calculated.

    - - - - - - - -

    Scalar Value Types

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    .proto TypeNotesC++JavaPythonGoC#PHPRuby
    doubledoubledoublefloatfloat64doublefloatFloat
    floatfloatfloatfloatfloat32floatfloatFloat
    int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
    int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
    uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
    uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
    sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
    sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
    fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
    fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
    sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
    sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
    boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
    stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
    bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)
    - - - diff --git a/docs/html/email_notifications.html b/docs/html/email_notifications.html index 4f0ad40..5577f9e 100644 --- a/docs/html/email_notifications.html +++ b/docs/html/email_notifications.html @@ -2604,35 +2604,11 @@

    EventType

    - MODEM_TRANSFER_STARTED - 17 -

    - - - - MODEM_TRANSFER_RECEIVED + TRANSFER 18

    - - MODEM_TRANSFER_CANCELLED - 19 -

    - - - - MODEM_TRANSFER_NOT_RECEIVED - 20 -

    - - - - MODEM_TRANSFER_RETURN_TRANSFER_STARTED - 21 -

    - - PUBLISHER_CREATED 1 diff --git a/docs/html/event.html b/docs/html/event.html index 2ad74e8..ddbbf34 100644 --- a/docs/html/event.html +++ b/docs/html/event.html @@ -426,6 +426,14 @@

    Table of Contents

    MEvent.TokenEvent.TokenExpiryWarningEvent +
  • + MEvent.TransferEvent +
    • + +
  • + MEvent.TransferEvent.DeprecatedTransfer +
    • +
  • MEvent.UserEvent
    • @@ -1296,10 +1304,6 @@

    Table of Contents

    MModem -
  • - MModem.ActiveSubscription -
    • -
  • MModem.ConnectedDeviceInfo
    • @@ -1320,10 +1324,6 @@

    Table of Contents

    MModem.TechnicalData -
  • - MModem.Transfer -
    • -
  • MModemHealthCount
    • @@ -1441,14 +1441,6 @@

    Table of Contents

    EModem.Lifecycle -
  • - EModem.Peripherals.HiberAntenna -
    • - -
  • - EModem.Transfer.Status -
    • -
  • EModem.Type
    • @@ -2016,14 +2008,6 @@

    Table of Contents

    MCreateOrganizationRequest -
  • - MDeleteOrganizationConfirmationRequest -
    • - -
  • - MDeleteOrganizationConfirmationRequest.Response -
    • -
  • MDeleteOrganizationRequest
    • @@ -2296,6 +2280,29 @@

    Table of Contents

    +
  • + transfer.proto + +
    • + +
  • webhook.proto