From a087c4c18b803bbcee00ee4eb457fa408c278fee Mon Sep 17 00:00:00 2001 From: Orne Brocaar Date: Thu, 19 Oct 2023 17:11:50 +0100 Subject: [PATCH] Add tags to tenants and applications. Note that the integration events will contain the application + device-profile + device tags. Integration events will NOT contain the tenant tags. Most likely tenant tags will be used to store information about the tenant, data that is unrelated to the integration events. Fixes #211. --- api/proto/api/application.proto | 6 + api/proto/api/device.proto | 4 +- api/proto/api/device_profile.proto | 713 +++++++++--------- api/proto/api/tenant.proto | 401 +++++----- .../proto/chirpstack/api/application.proto | 6 + api/rust/proto/chirpstack/api/device.proto | 4 +- api/rust/proto/chirpstack/api/tenant.proto | 401 +++++----- .../down.sql | 2 + .../up.sql | 15 + chirpstack/src/api/application.rs | 5 +- chirpstack/src/api/tenant.rs | 5 +- chirpstack/src/downlink/data.rs | 3 +- chirpstack/src/downlink/tx_ack.rs | 3 +- chirpstack/src/maccommand/dev_status.rs | 5 +- .../src/maccommand/notify_new_end_device.rs | 3 +- chirpstack/src/storage/application.rs | 5 +- chirpstack/src/storage/device.rs | 2 + chirpstack/src/storage/schema.rs | 2 + chirpstack/src/storage/tenant.rs | 8 +- chirpstack/src/uplink/data.rs | 6 +- chirpstack/src/uplink/join.rs | 3 +- chirpstack/src/uplink/join_sns.rs | 3 +- ui/src/views/applications/ApplicationForm.tsx | 64 +- ui/src/views/tenants/TenantForm.tsx | 167 ++-- 24 files changed, 1005 insertions(+), 831 deletions(-) create mode 100644 chirpstack/migrations/2023-10-19-142614_add_tenant_and_app_tags/down.sql create mode 100644 chirpstack/migrations/2023-10-19-142614_add_tenant_and_app_tags/up.sql diff --git a/api/proto/api/application.proto b/api/proto/api/application.proto index c0c98cc5..ca09c6a1 100644 --- a/api/proto/api/application.proto +++ b/api/proto/api/application.proto @@ -459,6 +459,12 @@ message Application { // Tenant ID (UUID). string tenant_id = 4; + + // Tags (user defined). + // These tags can be used to add additional information to the application. + // These tags are exposed in all the integration events of devices under + // this application. + map tags = 5; } message ApplicationListItem { diff --git a/api/proto/api/device.proto b/api/proto/api/device.proto index 0d739a0c..e21601eb 100644 --- a/api/proto/api/device.proto +++ b/api/proto/api/device.proto @@ -208,8 +208,8 @@ message Device { map variables = 8; // Tags (user defined). - // These tags are exposed in the event payloads or to integration. Tags are - // intended for aggregation and filtering. + // These tags can be used to add additional information to the device. + // These tags are exposed in all the integration events. map tags = 9; // JoinEUI (optional, EUI64). diff --git a/api/proto/api/device_profile.proto b/api/proto/api/device_profile.proto index a6112260..d3c1d4d2 100644 --- a/api/proto/api/device_profile.proto +++ b/api/proto/api/device_profile.proto @@ -14,502 +14,509 @@ import "google/protobuf/empty.proto"; import "common/common.proto"; enum CodecRuntime { - // None. - NONE = 0; + // None. + NONE = 0; - // Cayenne LPP. - CAYENNE_LPP = 1; + // Cayenne LPP. + CAYENNE_LPP = 1; - // JavaScript. - JS = 2; + // JavaScript. + JS = 2; } enum MeasurementKind { - // Unknown (in which case it is not tracked). - UNKNOWN = 0; + // Unknown (in which case it is not tracked). + UNKNOWN = 0; - // Incrementing counters that never decrease (these are not reset on each reading). - COUNTER = 1; + // Incrementing counters that never decrease (these are not reset on each + // reading). + COUNTER = 1; - // Counters that do get reset upon reading. - ABSOLUTE = 2; + // Counters that do get reset upon reading. + ABSOLUTE = 2; - // E.g. a temperature value. - GAUGE = 3; + // E.g. a temperature value. + GAUGE = 3; - // E.g. a firmware version, true / false value. - STRING = 4; + // E.g. a firmware version, true / false value. + STRING = 4; } enum CadPeriodicity { - // 1 second. - SEC_1 = 0; + // 1 second. + SEC_1 = 0; - // 500 milliseconds - MS_500 = 1; + // 500 milliseconds + MS_500 = 1; - // 250 milliseconds - MS_250 = 2; + // 250 milliseconds + MS_250 = 2; - // 100 milliseconds - MS_100 = 3; + // 100 milliseconds + MS_100 = 3; - // 50 milliseconds - MS_50 = 4; + // 50 milliseconds + MS_50 = 4; - // 20 milliseconds - MS_20 = 5; + // 20 milliseconds + MS_20 = 5; } enum SecondChAckOffset { - // 0 kHz. - KHZ_0 = 0; + // 0 kHz. + KHZ_0 = 0; - // 200 kHz. - KHZ_200 = 1; + // 200 kHz. + KHZ_200 = 1; - // 400 kHz. - KHZ_400 = 2; + // 400 kHz. + KHZ_400 = 2; - // 800 kHz. - KHZ_800 = 3; + // 800 kHz. + KHZ_800 = 3; - // 1600 kHz. - KHZ_1600 = 4; - - // 3200 kHz. - KHZ_3200 = 5; + // 1600 kHz. + KHZ_1600 = 4; + // 3200 kHz. + KHZ_3200 = 5; } enum RelayModeActivation { - // Disable the relay mode. - DISABLE_RELAY_MODE = 0; + // Disable the relay mode. + DISABLE_RELAY_MODE = 0; - // Enable the relay model. - ENABLE_RELAY_MODE = 1; + // Enable the relay model. + ENABLE_RELAY_MODE = 1; - // Dynamic. - DYNAMIC = 2; + // Dynamic. + DYNAMIC = 2; - // End-device controlled. - END_DEVICE_CONTROLLED = 3; + // End-device controlled. + END_DEVICE_CONTROLLED = 3; } -// DeviceProfileService is the service providing API methods for managing device-profiles. +// DeviceProfileService is the service providing API methods for managing +// device-profiles. service DeviceProfileService { - // Create the given device-profile. - rpc Create(CreateDeviceProfileRequest) returns (CreateDeviceProfileResponse) { - option(google.api.http) = { - post: "/api/device-profiles" - body: "*" - }; - } + // Create the given device-profile. + rpc Create(CreateDeviceProfileRequest) returns (CreateDeviceProfileResponse) { + option (google.api.http) = { + post : "/api/device-profiles" + body : "*" + }; + } - // Get the device-profile for the given ID. - rpc Get(GetDeviceProfileRequest) returns (GetDeviceProfileResponse) { - option(google.api.http) = { - get: "/api/device-profiles/{id}" - }; - } + // Get the device-profile for the given ID. + rpc Get(GetDeviceProfileRequest) returns (GetDeviceProfileResponse) { + option (google.api.http) = { + get : "/api/device-profiles/{id}" + }; + } - // Update the given device-profile. - rpc Update(UpdateDeviceProfileRequest) returns (google.protobuf.Empty) { - option(google.api.http) = { - put: "/api/device-profiles/{device_profile.id}" - body: "*" - }; - } + // Update the given device-profile. + rpc Update(UpdateDeviceProfileRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + put : "/api/device-profiles/{device_profile.id}" + body : "*" + }; + } - // Delete the device-profile with the given ID. - rpc Delete(DeleteDeviceProfileRequest) returns (google.protobuf.Empty) { - option(google.api.http) = { - delete: "/api/device-profiles/{id}" - }; - } - - // List the available device-profiles. - rpc List(ListDeviceProfilesRequest) returns (ListDeviceProfilesResponse) { - option(google.api.http) = { - get: "/api/device-profiles" - }; - } + // Delete the device-profile with the given ID. + rpc Delete(DeleteDeviceProfileRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + delete : "/api/device-profiles/{id}" + }; + } - // List available ADR algorithms. - rpc ListAdrAlgorithms(google.protobuf.Empty) returns (ListDeviceProfileAdrAlgorithmsResponse) { - option(google.api.http) = { - get: "/api/device-profiles/adr-algorithms" - }; - } + // List the available device-profiles. + rpc List(ListDeviceProfilesRequest) returns (ListDeviceProfilesResponse) { + option (google.api.http) = { + get : "/api/device-profiles" + }; + } + + // List available ADR algorithms. + rpc ListAdrAlgorithms(google.protobuf.Empty) + returns (ListDeviceProfileAdrAlgorithmsResponse) { + option (google.api.http) = { + get : "/api/device-profiles/adr-algorithms" + }; + } } message DeviceProfile { - // Device-profile ID (UUID). - // Note: on create this will be automatically generated. - string id = 1; + // Device-profile ID (UUID). + // Note: on create this will be automatically generated. + string id = 1; - // Tenant ID (UUID). - string tenant_id = 2; + // Tenant ID (UUID). + string tenant_id = 2; - // Name. - string name = 3; + // Name. + string name = 3; - // Description. - string description = 26; + // Description. + string description = 26; - // Region. - common.Region region = 4; + // Region. + common.Region region = 4; - // LoRaWAN mac-version. - common.MacVersion mac_version = 5; + // LoRaWAN mac-version. + common.MacVersion mac_version = 5; - // Regional parameters revision. - common.RegParamsRevision reg_params_revision = 6; + // Regional parameters revision. + common.RegParamsRevision reg_params_revision = 6; - // ADR algorithm ID. - string adr_algorithm_id = 7; + // ADR algorithm ID. + string adr_algorithm_id = 7; - // Payload codec runtime. - CodecRuntime payload_codec_runtime = 8; + // Payload codec runtime. + CodecRuntime payload_codec_runtime = 8; - // Payload codec script. - string payload_codec_script = 9; + // Payload codec script. + string payload_codec_script = 9; - // Flush queue on device activation. - bool flush_queue_on_activate = 10; + // Flush queue on device activation. + bool flush_queue_on_activate = 10; - // Uplink interval (seconds). - // This defines the expected uplink interval which the device uses for - // communication. If the uplink interval has expired and no uplink has - // been received, the device is considered inactive. - uint32 uplink_interval = 11; + // Uplink interval (seconds). + // This defines the expected uplink interval which the device uses for + // communication. If the uplink interval has expired and no uplink has + // been received, the device is considered inactive. + uint32 uplink_interval = 11; - // Device-status request interval (times / day). - // This defines the times per day that ChirpStack will request the device-status - // from the device. - uint32 device_status_req_interval = 12; + // Device-status request interval (times / day). + // This defines the times per day that ChirpStack will request the + // device-status from the device. + uint32 device_status_req_interval = 12; - // Supports OTAA. - bool supports_otaa = 13; + // Supports OTAA. + bool supports_otaa = 13; - // Supports Class B. - bool supports_class_b = 14; + // Supports Class B. + bool supports_class_b = 14; - // Supports Class-C. - bool supports_class_c = 15; + // Supports Class-C. + bool supports_class_c = 15; - // Class-B timeout (seconds). - // This is the maximum time ChirpStack will wait to receive an acknowledgement from the device (if requested). - uint32 class_b_timeout = 16; + // Class-B timeout (seconds). + // This is the maximum time ChirpStack will wait to receive an acknowledgement + // from the device (if requested). + uint32 class_b_timeout = 16; - // Class-B ping-slots per beacon period. - // Valid options are: 0 - 7. - // - // The actual number of ping-slots per beacon period equals to 2^k. - uint32 class_b_ping_slot_nb_k = 17; + // Class-B ping-slots per beacon period. + // Valid options are: 0 - 7. + // + // The actual number of ping-slots per beacon period equals to 2^k. + uint32 class_b_ping_slot_nb_k = 17; - // Class-B ping-slot DR. - uint32 class_b_ping_slot_dr = 18; + // Class-B ping-slot DR. + uint32 class_b_ping_slot_dr = 18; - // Class-B ping-slot freq (Hz). - uint32 class_b_ping_slot_freq = 19; + // Class-B ping-slot freq (Hz). + uint32 class_b_ping_slot_freq = 19; - // Class-C timeout (seconds). - // This is the maximum time ChirpStack will wait to receive an acknowledgement from the device (if requested). - uint32 class_c_timeout = 20; + // Class-C timeout (seconds). + // This is the maximum time ChirpStack will wait to receive an acknowledgement + // from the device (if requested). + uint32 class_c_timeout = 20; - // RX1 delay (for ABP). - uint32 abp_rx1_delay = 21; + // RX1 delay (for ABP). + uint32 abp_rx1_delay = 21; - // RX1 DR offset (for ABP). - uint32 abp_rx1_dr_offset = 22; + // RX1 DR offset (for ABP). + uint32 abp_rx1_dr_offset = 22; - // RX2 DR (for ABP). - uint32 abp_rx2_dr = 23; + // RX2 DR (for ABP). + uint32 abp_rx2_dr = 23; - // RX2 frequency (for ABP, Hz). - uint32 abp_rx2_freq = 24; + // RX2 frequency (for ABP, Hz). + uint32 abp_rx2_freq = 24; - // User defined tags. - map tags = 25; + // Tags (user defined). + // These tags can be used to add additional information the the + // device-profile. These tags are exposed in all the integration events of + // devices using this device-profile. + map tags = 25; - // Measurements. - // If defined, ChirpStack will visualize these metrics in the web-interface. - map measurements = 27; + // Measurements. + // If defined, ChirpStack will visualize these metrics in the web-interface. + map measurements = 27; - // Auto-detect measurements. - // If set to true, measurements will be automatically added based on the - // keys of the decoded payload. In cases where the decoded payload contains - // random keys in the data, you want to set this to false. - bool auto_detect_measurements = 28; + // Auto-detect measurements. + // If set to true, measurements will be automatically added based on the + // keys of the decoded payload. In cases where the decoded payload contains + // random keys in the data, you want to set this to false. + bool auto_detect_measurements = 28; - // Region configuration ID. - // If set, devices will only use the associated region. If let blank, then - // devices will use all regions matching the selected common-name. Note - // that multiple region configurations can exist for the same common-name, - // e.g. to provide an 8 channel and 16 channel configuration for the US915 - // band. - string region_config_id = 29; + // Region configuration ID. + // If set, devices will only use the associated region. If let blank, then + // devices will use all regions matching the selected common-name. Note + // that multiple region configurations can exist for the same common-name, + // e.g. to provide an 8 channel and 16 channel configuration for the US915 + // band. + string region_config_id = 29; - // Device is a Relay device. - // Enable this in case the device is a Relay. A Relay device implements TS011 - // and is able to relay data from relay capable devices. - // See for more information the TS011 specification. - bool is_relay = 30; + // Device is a Relay device. + // Enable this in case the device is a Relay. A Relay device implements TS011 + // and is able to relay data from relay capable devices. + // See for more information the TS011 specification. + bool is_relay = 30; - // Device is a Relay end-device. - // Enable this in case the device is an end-device that can operate under a - // Relay. Please refer to the TS011 specification for more information. - bool is_relay_ed = 31; + // Device is a Relay end-device. + // Enable this in case the device is an end-device that can operate under a + // Relay. Please refer to the TS011 specification for more information. + bool is_relay_ed = 31; - // End-device only accept data through relay. - // Only accept data for this device through a relay. This setting is useful - // for testing as in case of a test-setup, the end-device is usually within - // range of the gateway. - bool relay_ed_relay_only = 32; + // End-device only accept data through relay. + // Only accept data for this device through a relay. This setting is useful + // for testing as in case of a test-setup, the end-device is usually within + // range of the gateway. + bool relay_ed_relay_only = 32; - // Relay must be enabled. - bool relay_enabled = 33; + // Relay must be enabled. + bool relay_enabled = 33; - // Relay CAD periodicity. - CadPeriodicity relay_cad_periodicity = 34; + // Relay CAD periodicity. + CadPeriodicity relay_cad_periodicity = 34; - // Relay default channel index. - // Valid values are 0 and 1, please refer to the RP002 specification for - // the meaning of these values. - uint32 relay_default_channel_index = 35; + // Relay default channel index. + // Valid values are 0 and 1, please refer to the RP002 specification for + // the meaning of these values. + uint32 relay_default_channel_index = 35; - // Relay second channel frequency (Hz). - uint32 relay_second_channel_freq = 36; + // Relay second channel frequency (Hz). + uint32 relay_second_channel_freq = 36; - // Relay second channel DR. - uint32 relay_second_channel_dr = 37; + // Relay second channel DR. + uint32 relay_second_channel_dr = 37; - // Relay second channel ACK offset. - SecondChAckOffset relay_second_channel_ack_offset = 38; + // Relay second channel ACK offset. + SecondChAckOffset relay_second_channel_ack_offset = 38; - // Relay end-device activation mode. - RelayModeActivation relay_ed_activation_mode = 39; + // Relay end-device activation mode. + RelayModeActivation relay_ed_activation_mode = 39; - // Relay end-device smart-enable level. - uint32 relay_ed_smart_enable_level = 40; + // Relay end-device smart-enable level. + uint32 relay_ed_smart_enable_level = 40; - // Relay end-device back-off (in case it does not receive WOR ACK frame). - // 0 = Always send a LoRaWAN uplink - // 1..63 = Send a LoRaWAN uplink after X WOR frames without a WOR ACK - uint32 relay_ed_back_off = 41; + // Relay end-device back-off (in case it does not receive WOR ACK frame). + // 0 = Always send a LoRaWAN uplink + // 1..63 = Send a LoRaWAN uplink after X WOR frames without a WOR ACK + uint32 relay_ed_back_off = 41; - // Relay end-device uplink limit bucket size. - // - // This field indicates the multiplier to determine the bucket size - // according to the following formula: - // BucketSize TOKEN = _reload_rate x _bucket_size - // - // Valid values (0 - 3): - // 0 = 1 - // 1 = 2 - // 2 = 4 - // 3 = 12 - uint32 relay_ed_uplink_limit_bucket_size = 42; + // Relay end-device uplink limit bucket size. + // + // This field indicates the multiplier to determine the bucket size + // according to the following formula: + // BucketSize TOKEN = _reload_rate x _bucket_size + // + // Valid values (0 - 3): + // 0 = 1 + // 1 = 2 + // 2 = 4 + // 3 = 12 + uint32 relay_ed_uplink_limit_bucket_size = 42; - // Relay end-device uplink limit reload rate. - // - // Valid values: - // * 0 - 62 = X tokens every hour - // * 63 = no limitation - uint32 relay_ed_uplink_limit_reload_rate = 43; + // Relay end-device uplink limit reload rate. + // + // Valid values: + // * 0 - 62 = X tokens every hour + // * 63 = no limitation + uint32 relay_ed_uplink_limit_reload_rate = 43; - // Relay join-request limit reload rate. - // - // Valid values: - // * 0 - 126 = X tokens every hour - // * 127 = no limitation - uint32 relay_join_req_limit_reload_rate = 44; + // Relay join-request limit reload rate. + // + // Valid values: + // * 0 - 126 = X tokens every hour + // * 127 = no limitation + uint32 relay_join_req_limit_reload_rate = 44; - // Relay notify limit reload rate. - // - // Valid values: - // * 0 - 126 = X tokens every hour - // * 127 = no limitation - uint32 relay_notify_limit_reload_rate = 45; + // Relay notify limit reload rate. + // + // Valid values: + // * 0 - 126 = X tokens every hour + // * 127 = no limitation + uint32 relay_notify_limit_reload_rate = 45; - // Relay global uplink limit reload rate. - // - // Valid values: - // * 0 - 126 = X tokens every hour - // * 127 = no limitation - uint32 relay_global_uplink_limit_reload_rate = 46; + // Relay global uplink limit reload rate. + // + // Valid values: + // * 0 - 126 = X tokens every hour + // * 127 = no limitation + uint32 relay_global_uplink_limit_reload_rate = 46; - // Relay overall limit reload rate. - // - // Valid values: - // * 0 - 126 = X tokens every hour - // * 127 = no limitation - uint32 relay_overall_limit_reload_rate = 47; + // Relay overall limit reload rate. + // + // Valid values: + // * 0 - 126 = X tokens every hour + // * 127 = no limitation + uint32 relay_overall_limit_reload_rate = 47; - // Relay join-request limit bucket size. - // - // This field indicates the multiplier to determine the bucket size - // according to the following formula: - // BucketSize TOKEN = _reload_rate x _bucket_size - // - // Valid values (0 - 3): - // 0 = 1 - // 1 = 2 - // 2 = 4 - // 3 = 12 - uint32 relay_join_req_limit_bucket_size = 48; + // Relay join-request limit bucket size. + // + // This field indicates the multiplier to determine the bucket size + // according to the following formula: + // BucketSize TOKEN = _reload_rate x _bucket_size + // + // Valid values (0 - 3): + // 0 = 1 + // 1 = 2 + // 2 = 4 + // 3 = 12 + uint32 relay_join_req_limit_bucket_size = 48; - // Relay notify limit bucket size. - // - // This field indicates the multiplier to determine the bucket size - // according to the following formula: - // BucketSize TOKEN = _reload_rate x _bucket_size - // - // Valid values (0 - 3): - // 0 = 1 - // 1 = 2 - // 2 = 4 - // 3 = 12 - uint32 relay_notify_limit_bucket_size = 49; + // Relay notify limit bucket size. + // + // This field indicates the multiplier to determine the bucket size + // according to the following formula: + // BucketSize TOKEN = _reload_rate x _bucket_size + // + // Valid values (0 - 3): + // 0 = 1 + // 1 = 2 + // 2 = 4 + // 3 = 12 + uint32 relay_notify_limit_bucket_size = 49; - // Relay globak uplink limit bucket size. - // - // This field indicates the multiplier to determine the bucket size - // according to the following formula: - // BucketSize TOKEN = _reload_rate x _bucket_size - // - // Valid values (0 - 3): - // 0 = 1 - // 1 = 2 - // 2 = 4 - // 3 = 12 - uint32 relay_global_uplink_limit_bucket_size = 50; + // Relay globak uplink limit bucket size. + // + // This field indicates the multiplier to determine the bucket size + // according to the following formula: + // BucketSize TOKEN = _reload_rate x _bucket_size + // + // Valid values (0 - 3): + // 0 = 1 + // 1 = 2 + // 2 = 4 + // 3 = 12 + uint32 relay_global_uplink_limit_bucket_size = 50; - // Relay overall limit bucket size. - // - // This field indicates the multiplier to determine the bucket size - // according to the following formula: - // BucketSize TOKEN = _reload_rate x _bucket_size - // - // Valid values (0 - 3): - // 0 = 1 - // 1 = 2 - // 2 = 4 - // 3 = 12 - uint32 relay_overall_limit_bucket_size = 51; + // Relay overall limit bucket size. + // + // This field indicates the multiplier to determine the bucket size + // according to the following formula: + // BucketSize TOKEN = _reload_rate x _bucket_size + // + // Valid values (0 - 3): + // 0 = 1 + // 1 = 2 + // 2 = 4 + // 3 = 12 + uint32 relay_overall_limit_bucket_size = 51; } message Measurement { - // Name (user defined). - string name = 2; + // Name (user defined). + string name = 2; - // Kind. - MeasurementKind kind = 3; + // Kind. + MeasurementKind kind = 3; } message DeviceProfileListItem { - // Device-profile ID (UUID). - string id = 1; + // Device-profile ID (UUID). + string id = 1; - // Created at timestamp. - google.protobuf.Timestamp created_at = 2; + // Created at timestamp. + google.protobuf.Timestamp created_at = 2; - // Last update timestamp. - google.protobuf.Timestamp updated_at = 3; + // Last update timestamp. + google.protobuf.Timestamp updated_at = 3; - // Name. - string name = 4; + // Name. + string name = 4; - // Region. - common.Region region = 5; + // Region. + common.Region region = 5; - // LoRaWAN mac-version. - common.MacVersion mac_version = 6; + // LoRaWAN mac-version. + common.MacVersion mac_version = 6; - // Regional parameters revision. - common.RegParamsRevision reg_params_revision = 7; + // Regional parameters revision. + common.RegParamsRevision reg_params_revision = 7; - // Supports OTAA. - bool supports_otaa = 8; + // Supports OTAA. + bool supports_otaa = 8; - // Supports Class-B. - bool supports_class_b = 9; + // Supports Class-B. + bool supports_class_b = 9; - // Supports Class-C. - bool supports_class_c = 10; + // Supports Class-C. + bool supports_class_c = 10; } message CreateDeviceProfileRequest { - // Object to create. - DeviceProfile device_profile = 1; + // Object to create. + DeviceProfile device_profile = 1; } message CreateDeviceProfileResponse { - // ID (UUID). - string id = 1; + // ID (UUID). + string id = 1; } message GetDeviceProfileRequest { - // ID (UUID). - string id = 1; + // ID (UUID). + string id = 1; } message GetDeviceProfileResponse { - // Device-profile object. - DeviceProfile device_profile = 1; + // Device-profile object. + DeviceProfile device_profile = 1; - // Created at timestamp. - google.protobuf.Timestamp created_at = 2; + // Created at timestamp. + google.protobuf.Timestamp created_at = 2; - // Last update timestamp. - google.protobuf.Timestamp updated_at = 3; + // Last update timestamp. + google.protobuf.Timestamp updated_at = 3; } message UpdateDeviceProfileRequest { - // Device-profile object. - DeviceProfile device_profile = 1; + // Device-profile object. + DeviceProfile device_profile = 1; } message DeleteDeviceProfileRequest { - // ID (UUID). - string id = 1; + // ID (UUID). + string id = 1; } message ListDeviceProfilesRequest { - // Max number of device-profiles to return in the result-set. - uint32 limit = 1; + // Max number of device-profiles to return in the result-set. + uint32 limit = 1; - // Offset in the result-set (for pagination). - uint32 offset = 2; + // Offset in the result-set (for pagination). + uint32 offset = 2; - // If set, the given string will be used to search on name. - string search = 3; + // If set, the given string will be used to search on name. + string search = 3; - // Tenant ID to list the device-profiles for. - string tenant_id = 4; + // Tenant ID to list the device-profiles for. + string tenant_id = 4; } message ListDeviceProfilesResponse { - // Total number of device-profiles. - uint32 total_count = 1; + // Total number of device-profiles. + uint32 total_count = 1; - // Result-set. - repeated DeviceProfileListItem result = 2; + // Result-set. + repeated DeviceProfileListItem result = 2; } message ListDeviceProfileAdrAlgorithmsResponse { - // Total number of algorithms. - uint32 total_count = 1; + // Total number of algorithms. + uint32 total_count = 1; - // Result-set. - repeated AdrAlgorithmListItem result = 2; + // Result-set. + repeated AdrAlgorithmListItem result = 2; } message AdrAlgorithmListItem { - // Algorithm ID. - string id = 1; + // Algorithm ID. + string id = 1; - // Algorithm name. - string name = 2; + // Algorithm name. + string name = 2; } diff --git a/api/proto/api/tenant.proto b/api/proto/api/tenant.proto index 809fb88d..e1a20f30 100644 --- a/api/proto/api/tenant.proto +++ b/api/proto/api/tenant.proto @@ -14,308 +14,313 @@ import "google/protobuf/empty.proto"; // TenantService is the service providing API methods for managing tenants. service TenantService { - // Create a new tenant. - rpc Create(CreateTenantRequest) returns (CreateTenantResponse) { - option(google.api.http) = { - post: "/api/tenants" - body: "*" - }; - } + // Create a new tenant. + rpc Create(CreateTenantRequest) returns (CreateTenantResponse) { + option (google.api.http) = { + post : "/api/tenants" + body : "*" + }; + } - // Get the tenant for the given ID. - rpc Get(GetTenantRequest) returns (GetTenantResponse) { - option(google.api.http) = { - get: "/api/tenants/{id}" - }; - } + // Get the tenant for the given ID. + rpc Get(GetTenantRequest) returns (GetTenantResponse) { + option (google.api.http) = { + get : "/api/tenants/{id}" + }; + } - // Update the given tenant. - rpc Update(UpdateTenantRequest) returns (google.protobuf.Empty) { - option(google.api.http) = { - put: "/api/tenants/{tenant.id}" - body: "*" - }; - } + // Update the given tenant. + rpc Update(UpdateTenantRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + put : "/api/tenants/{tenant.id}" + body : "*" + }; + } - // Delete the tenant with the given ID. - rpc Delete(DeleteTenantRequest) returns (google.protobuf.Empty) { - option(google.api.http) = { - delete: "/api/tenants/{id}" - }; - } + // Delete the tenant with the given ID. + rpc Delete(DeleteTenantRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + delete : "/api/tenants/{id}" + }; + } - // Get the list of tenants. - rpc List(ListTenantsRequest) returns (ListTenantsResponse) { - option(google.api.http) = { - get: "/api/tenants" - }; - } + // Get the list of tenants. + rpc List(ListTenantsRequest) returns (ListTenantsResponse) { + option (google.api.http) = { + get : "/api/tenants" + }; + } - // Add an user to the tenant. - // Note: the user must already exist. - rpc AddUser(AddTenantUserRequest) returns (google.protobuf.Empty) { - option(google.api.http) = { - post: "/api/tenants/{tenant_user.tenant_id}/users" - body: "*" - }; - } + // Add an user to the tenant. + // Note: the user must already exist. + rpc AddUser(AddTenantUserRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + post : "/api/tenants/{tenant_user.tenant_id}/users" + body : "*" + }; + } - // Get the the tenant user for the given tenant and user IDs. - rpc GetUser(GetTenantUserRequest) returns (GetTenantUserResponse) { - option(google.api.http) = { - get: "/api/tenants/{tenant_id}/users/{user_id}" - }; - } + // Get the the tenant user for the given tenant and user IDs. + rpc GetUser(GetTenantUserRequest) returns (GetTenantUserResponse) { + option (google.api.http) = { + get : "/api/tenants/{tenant_id}/users/{user_id}" + }; + } - // Update the given tenant user. - rpc UpdateUser(UpdateTenantUserRequest) returns (google.protobuf.Empty) { - option(google.api.http) = { - put: "/api/tenants/{tenant_user.tenant_id}/users/{tenant_user.user_id}" - body: "*" - }; - } + // Update the given tenant user. + rpc UpdateUser(UpdateTenantUserRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + put : "/api/tenants/{tenant_user.tenant_id}/users/{tenant_user.user_id}" + body : "*" + }; + } - // Delete the given tenant user. - rpc DeleteUser(DeleteTenantUserRequest) returns (google.protobuf.Empty) { - option(google.api.http) = { - delete: "/api/tenants/{tenant_id}/users/{user_id}" - }; - } + // Delete the given tenant user. + rpc DeleteUser(DeleteTenantUserRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + delete : "/api/tenants/{tenant_id}/users/{user_id}" + }; + } - // Get the list of tenant users. - rpc ListUsers(ListTenantUsersRequest) returns (ListTenantUsersResponse) { - option(google.api.http) = { - get: "/api/tenants/{tenant_id}/users" - }; - } + // Get the list of tenant users. + rpc ListUsers(ListTenantUsersRequest) returns (ListTenantUsersResponse) { + option (google.api.http) = { + get : "/api/tenants/{tenant_id}/users" + }; + } } message Tenant { - // Tenant ID (UUID). - // Note: this value will be automatically generated on create. - string id = 1; + // Tenant ID (UUID). + // Note: this value will be automatically generated on create. + string id = 1; - // Tenant name, - string name = 2; + // Tenant name, + string name = 2; - // Tenant description. - string description = 3; + // Tenant description. + string description = 3; - // Can the tenant create and "own" Gateways? - bool can_have_gateways = 4; + // Can the tenant create and "own" Gateways? + bool can_have_gateways = 4; - // Max. gateway count for tenant. - // When set to 0, the tenant can have unlimited gateways. - uint32 max_gateway_count = 5; + // Max. gateway count for tenant. + // When set to 0, the tenant can have unlimited gateways. + uint32 max_gateway_count = 5; - // Max. device count for tenant. - // When set to 0, the tenant can have unlimited devices. - uint32 max_device_count = 6; + // Max. device count for tenant. + // When set to 0, the tenant can have unlimited devices. + uint32 max_device_count = 6; - // Private gateways (uplink). - // If enabled, then uplink messages will not be shared with other tenants. - bool private_gateways_up = 7; + // Private gateways (uplink). + // If enabled, then uplink messages will not be shared with other tenants. + bool private_gateways_up = 7; - // Private gateways (downlink). - // If enabled, then other tenants will not be able to schedule downlink - // messages through the gateways of this tenant. For example, in case you - // do want to share uplinks with other tenants (private_gateways_up=false), - // but you want to prevent other tenants from using gateway airtime. - bool private_gateways_down = 8; + // Private gateways (downlink). + // If enabled, then other tenants will not be able to schedule downlink + // messages through the gateways of this tenant. For example, in case you + // do want to share uplinks with other tenants (private_gateways_up=false), + // but you want to prevent other tenants from using gateway airtime. + bool private_gateways_down = 8; + + // Tags (user defined). + // These tags can be used to add additional information to the tenant. These + // tags are NOT exposed in the integration events. + map tags = 9; } message TenantListItem { - // Tenant ID (UUID). - string id = 1; + // Tenant ID (UUID). + string id = 1; - // Created at timestamp. - google.protobuf.Timestamp created_at = 2; + // Created at timestamp. + google.protobuf.Timestamp created_at = 2; - // Last update timestamp. - google.protobuf.Timestamp updated_at = 3; + // Last update timestamp. + google.protobuf.Timestamp updated_at = 3; - // Tenant name. - string name = 4; + // Tenant name. + string name = 4; - // Can the tenant create and "own" Gateways? - bool can_have_gateways = 5; + // Can the tenant create and "own" Gateways? + bool can_have_gateways = 5; - // Private gateways (uplink). - bool private_gateways_up = 6; + // Private gateways (uplink). + bool private_gateways_up = 6; - // Private gateways (downlink). - bool private_gateways_down = 9; + // Private gateways (downlink). + bool private_gateways_down = 9; - // Max gateway count. - // 0 = unlimited. - uint32 max_gateway_count = 7; + // Max gateway count. + // 0 = unlimited. + uint32 max_gateway_count = 7; - // Max device count. - // 0 = unlimited. - uint32 max_device_count = 8; + // Max device count. + // 0 = unlimited. + uint32 max_device_count = 8; } message CreateTenantRequest { - // Tenant object to create. - Tenant tenant = 1; + // Tenant object to create. + Tenant tenant = 1; } message CreateTenantResponse { - // Tenant ID. - string id = 1; + // Tenant ID. + string id = 1; } message GetTenantRequest { - // Tenant ID. - string id = 1; + // Tenant ID. + string id = 1; } message GetTenantResponse { - // Tenant object. - Tenant tenant = 1; + // Tenant object. + Tenant tenant = 1; - // Created at timestamp. - google.protobuf.Timestamp created_at = 2; + // Created at timestamp. + google.protobuf.Timestamp created_at = 2; - // Last update timestamp. - google.protobuf.Timestamp updated_at = 3; + // Last update timestamp. + google.protobuf.Timestamp updated_at = 3; } message UpdateTenantRequest { - // Tenant object. - Tenant tenant = 1; + // Tenant object. + Tenant tenant = 1; } message DeleteTenantRequest { - // Tenant ID. - string id = 1; + // Tenant ID. + string id = 1; } message ListTenantsRequest { - // Max number of tenants to return in the result-set. - uint32 limit = 1; + // Max number of tenants to return in the result-set. + uint32 limit = 1; - // Offset in the result-set (for pagination). - uint32 offset = 2; + // Offset in the result-set (for pagination). + uint32 offset = 2; - // If set, the given string will be used to search on name. - string search = 3; + // If set, the given string will be used to search on name. + string search = 3; - // If set, filters the result set to the tenants of the user. - // Only global API keys are able to filter by this field. - string user_id = 4; + // If set, filters the result set to the tenants of the user. + // Only global API keys are able to filter by this field. + string user_id = 4; } message ListTenantsResponse { - // Total number of tenants. - uint32 total_count = 1; + // Total number of tenants. + uint32 total_count = 1; - // Result-set. - repeated TenantListItem result = 2; + // Result-set. + repeated TenantListItem result = 2; } message TenantUser { - // Tenant ID (UUID). - string tenant_id = 1; + // Tenant ID (UUID). + string tenant_id = 1; - // User ID (UUID). - string user_id = 2; + // User ID (UUID). + string user_id = 2; - // User is admin within the context of the tenant. - // There is no need to set the is_device_admin and is_gateway_admin flags. - bool is_admin = 3; + // User is admin within the context of the tenant. + // There is no need to set the is_device_admin and is_gateway_admin flags. + bool is_admin = 3; - // User is able to modify device related resources (applications, - // device-profiles, devices, multicast-groups). - bool is_device_admin = 4; + // User is able to modify device related resources (applications, + // device-profiles, devices, multicast-groups). + bool is_device_admin = 4; - // User is able to modify gateways. - bool is_gateway_admin = 5; + // User is able to modify gateways. + bool is_gateway_admin = 5; - // Email (only used on get and when adding a user to a tenant). - string email = 6; + // Email (only used on get and when adding a user to a tenant). + string email = 6; } message TenantUserListItem { - // Tenant ID (UUID). - string tenant_id = 1; + // Tenant ID (UUID). + string tenant_id = 1; - // User ID (UUID). - string user_id = 2; + // User ID (UUID). + string user_id = 2; - // Created at timestamp. - google.protobuf.Timestamp created_at = 3; + // Created at timestamp. + google.protobuf.Timestamp created_at = 3; - // Last update timestamp. - google.protobuf.Timestamp updated_at = 4; + // Last update timestamp. + google.protobuf.Timestamp updated_at = 4; - // Email. - string email = 5; + // Email. + string email = 5; - // User is admin within the context of the tenant. - // There is no need to set the is_device_admin and is_gateway_admin flags. - bool is_admin = 6; + // User is admin within the context of the tenant. + // There is no need to set the is_device_admin and is_gateway_admin flags. + bool is_admin = 6; - // User is able to modify device related resources (applications, - // device-profiles, devices, multicast-groups). - bool is_device_admin = 7; + // User is able to modify device related resources (applications, + // device-profiles, devices, multicast-groups). + bool is_device_admin = 7; - // User is able to modify gateways. - bool is_gateway_admin = 8; + // User is able to modify gateways. + bool is_gateway_admin = 8; } message AddTenantUserRequest { - // Tenant user object. - TenantUser tenant_user = 1; + // Tenant user object. + TenantUser tenant_user = 1; } message GetTenantUserRequest { - // Tenant ID (UUID). - string tenant_id = 1; + // Tenant ID (UUID). + string tenant_id = 1; - // User ID (UUID). - string user_id = 2; + // User ID (UUID). + string user_id = 2; } message GetTenantUserResponse { - // Tenant user object. - TenantUser tenant_user = 1; + // Tenant user object. + TenantUser tenant_user = 1; - // Created at timestamp. - google.protobuf.Timestamp created_at = 2; + // Created at timestamp. + google.protobuf.Timestamp created_at = 2; - // Last update timestamp. - google.protobuf.Timestamp updated_at = 3; + // Last update timestamp. + google.protobuf.Timestamp updated_at = 3; } message UpdateTenantUserRequest { - // Tenant user object. - TenantUser tenant_user = 1; + // Tenant user object. + TenantUser tenant_user = 1; } message DeleteTenantUserRequest { - // Tenant ID (UUID). - string tenant_id = 1; + // Tenant ID (UUID). + string tenant_id = 1; - // User ID (UUID). - string user_id = 2; + // User ID (UUID). + string user_id = 2; } message ListTenantUsersRequest { - // Tenant ID (UUID). - string tenant_id = 1; + // Tenant ID (UUID). + string tenant_id = 1; - // Max number of tenants to return in the result-set. - uint32 limit = 2; + // Max number of tenants to return in the result-set. + uint32 limit = 2; - // Offset in the result-set (for pagination). - uint32 offset = 3; + // Offset in the result-set (for pagination). + uint32 offset = 3; } message ListTenantUsersResponse { - // Total number of tenants. - uint32 total_count = 1; + // Total number of tenants. + uint32 total_count = 1; - // Result-set. - repeated TenantUserListItem result = 2; + // Result-set. + repeated TenantUserListItem result = 2; } diff --git a/api/rust/proto/chirpstack/api/application.proto b/api/rust/proto/chirpstack/api/application.proto index c0c98cc5..ca09c6a1 100644 --- a/api/rust/proto/chirpstack/api/application.proto +++ b/api/rust/proto/chirpstack/api/application.proto @@ -459,6 +459,12 @@ message Application { // Tenant ID (UUID). string tenant_id = 4; + + // Tags (user defined). + // These tags can be used to add additional information to the application. + // These tags are exposed in all the integration events of devices under + // this application. + map tags = 5; } message ApplicationListItem { diff --git a/api/rust/proto/chirpstack/api/device.proto b/api/rust/proto/chirpstack/api/device.proto index 0d739a0c..e21601eb 100644 --- a/api/rust/proto/chirpstack/api/device.proto +++ b/api/rust/proto/chirpstack/api/device.proto @@ -208,8 +208,8 @@ message Device { map variables = 8; // Tags (user defined). - // These tags are exposed in the event payloads or to integration. Tags are - // intended for aggregation and filtering. + // These tags can be used to add additional information to the device. + // These tags are exposed in all the integration events. map tags = 9; // JoinEUI (optional, EUI64). diff --git a/api/rust/proto/chirpstack/api/tenant.proto b/api/rust/proto/chirpstack/api/tenant.proto index 809fb88d..e1a20f30 100644 --- a/api/rust/proto/chirpstack/api/tenant.proto +++ b/api/rust/proto/chirpstack/api/tenant.proto @@ -14,308 +14,313 @@ import "google/protobuf/empty.proto"; // TenantService is the service providing API methods for managing tenants. service TenantService { - // Create a new tenant. - rpc Create(CreateTenantRequest) returns (CreateTenantResponse) { - option(google.api.http) = { - post: "/api/tenants" - body: "*" - }; - } + // Create a new tenant. + rpc Create(CreateTenantRequest) returns (CreateTenantResponse) { + option (google.api.http) = { + post : "/api/tenants" + body : "*" + }; + } - // Get the tenant for the given ID. - rpc Get(GetTenantRequest) returns (GetTenantResponse) { - option(google.api.http) = { - get: "/api/tenants/{id}" - }; - } + // Get the tenant for the given ID. + rpc Get(GetTenantRequest) returns (GetTenantResponse) { + option (google.api.http) = { + get : "/api/tenants/{id}" + }; + } - // Update the given tenant. - rpc Update(UpdateTenantRequest) returns (google.protobuf.Empty) { - option(google.api.http) = { - put: "/api/tenants/{tenant.id}" - body: "*" - }; - } + // Update the given tenant. + rpc Update(UpdateTenantRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + put : "/api/tenants/{tenant.id}" + body : "*" + }; + } - // Delete the tenant with the given ID. - rpc Delete(DeleteTenantRequest) returns (google.protobuf.Empty) { - option(google.api.http) = { - delete: "/api/tenants/{id}" - }; - } + // Delete the tenant with the given ID. + rpc Delete(DeleteTenantRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + delete : "/api/tenants/{id}" + }; + } - // Get the list of tenants. - rpc List(ListTenantsRequest) returns (ListTenantsResponse) { - option(google.api.http) = { - get: "/api/tenants" - }; - } + // Get the list of tenants. + rpc List(ListTenantsRequest) returns (ListTenantsResponse) { + option (google.api.http) = { + get : "/api/tenants" + }; + } - // Add an user to the tenant. - // Note: the user must already exist. - rpc AddUser(AddTenantUserRequest) returns (google.protobuf.Empty) { - option(google.api.http) = { - post: "/api/tenants/{tenant_user.tenant_id}/users" - body: "*" - }; - } + // Add an user to the tenant. + // Note: the user must already exist. + rpc AddUser(AddTenantUserRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + post : "/api/tenants/{tenant_user.tenant_id}/users" + body : "*" + }; + } - // Get the the tenant user for the given tenant and user IDs. - rpc GetUser(GetTenantUserRequest) returns (GetTenantUserResponse) { - option(google.api.http) = { - get: "/api/tenants/{tenant_id}/users/{user_id}" - }; - } + // Get the the tenant user for the given tenant and user IDs. + rpc GetUser(GetTenantUserRequest) returns (GetTenantUserResponse) { + option (google.api.http) = { + get : "/api/tenants/{tenant_id}/users/{user_id}" + }; + } - // Update the given tenant user. - rpc UpdateUser(UpdateTenantUserRequest) returns (google.protobuf.Empty) { - option(google.api.http) = { - put: "/api/tenants/{tenant_user.tenant_id}/users/{tenant_user.user_id}" - body: "*" - }; - } + // Update the given tenant user. + rpc UpdateUser(UpdateTenantUserRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + put : "/api/tenants/{tenant_user.tenant_id}/users/{tenant_user.user_id}" + body : "*" + }; + } - // Delete the given tenant user. - rpc DeleteUser(DeleteTenantUserRequest) returns (google.protobuf.Empty) { - option(google.api.http) = { - delete: "/api/tenants/{tenant_id}/users/{user_id}" - }; - } + // Delete the given tenant user. + rpc DeleteUser(DeleteTenantUserRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + delete : "/api/tenants/{tenant_id}/users/{user_id}" + }; + } - // Get the list of tenant users. - rpc ListUsers(ListTenantUsersRequest) returns (ListTenantUsersResponse) { - option(google.api.http) = { - get: "/api/tenants/{tenant_id}/users" - }; - } + // Get the list of tenant users. + rpc ListUsers(ListTenantUsersRequest) returns (ListTenantUsersResponse) { + option (google.api.http) = { + get : "/api/tenants/{tenant_id}/users" + }; + } } message Tenant { - // Tenant ID (UUID). - // Note: this value will be automatically generated on create. - string id = 1; + // Tenant ID (UUID). + // Note: this value will be automatically generated on create. + string id = 1; - // Tenant name, - string name = 2; + // Tenant name, + string name = 2; - // Tenant description. - string description = 3; + // Tenant description. + string description = 3; - // Can the tenant create and "own" Gateways? - bool can_have_gateways = 4; + // Can the tenant create and "own" Gateways? + bool can_have_gateways = 4; - // Max. gateway count for tenant. - // When set to 0, the tenant can have unlimited gateways. - uint32 max_gateway_count = 5; + // Max. gateway count for tenant. + // When set to 0, the tenant can have unlimited gateways. + uint32 max_gateway_count = 5; - // Max. device count for tenant. - // When set to 0, the tenant can have unlimited devices. - uint32 max_device_count = 6; + // Max. device count for tenant. + // When set to 0, the tenant can have unlimited devices. + uint32 max_device_count = 6; - // Private gateways (uplink). - // If enabled, then uplink messages will not be shared with other tenants. - bool private_gateways_up = 7; + // Private gateways (uplink). + // If enabled, then uplink messages will not be shared with other tenants. + bool private_gateways_up = 7; - // Private gateways (downlink). - // If enabled, then other tenants will not be able to schedule downlink - // messages through the gateways of this tenant. For example, in case you - // do want to share uplinks with other tenants (private_gateways_up=false), - // but you want to prevent other tenants from using gateway airtime. - bool private_gateways_down = 8; + // Private gateways (downlink). + // If enabled, then other tenants will not be able to schedule downlink + // messages through the gateways of this tenant. For example, in case you + // do want to share uplinks with other tenants (private_gateways_up=false), + // but you want to prevent other tenants from using gateway airtime. + bool private_gateways_down = 8; + + // Tags (user defined). + // These tags can be used to add additional information to the tenant. These + // tags are NOT exposed in the integration events. + map tags = 9; } message TenantListItem { - // Tenant ID (UUID). - string id = 1; + // Tenant ID (UUID). + string id = 1; - // Created at timestamp. - google.protobuf.Timestamp created_at = 2; + // Created at timestamp. + google.protobuf.Timestamp created_at = 2; - // Last update timestamp. - google.protobuf.Timestamp updated_at = 3; + // Last update timestamp. + google.protobuf.Timestamp updated_at = 3; - // Tenant name. - string name = 4; + // Tenant name. + string name = 4; - // Can the tenant create and "own" Gateways? - bool can_have_gateways = 5; + // Can the tenant create and "own" Gateways? + bool can_have_gateways = 5; - // Private gateways (uplink). - bool private_gateways_up = 6; + // Private gateways (uplink). + bool private_gateways_up = 6; - // Private gateways (downlink). - bool private_gateways_down = 9; + // Private gateways (downlink). + bool private_gateways_down = 9; - // Max gateway count. - // 0 = unlimited. - uint32 max_gateway_count = 7; + // Max gateway count. + // 0 = unlimited. + uint32 max_gateway_count = 7; - // Max device count. - // 0 = unlimited. - uint32 max_device_count = 8; + // Max device count. + // 0 = unlimited. + uint32 max_device_count = 8; } message CreateTenantRequest { - // Tenant object to create. - Tenant tenant = 1; + // Tenant object to create. + Tenant tenant = 1; } message CreateTenantResponse { - // Tenant ID. - string id = 1; + // Tenant ID. + string id = 1; } message GetTenantRequest { - // Tenant ID. - string id = 1; + // Tenant ID. + string id = 1; } message GetTenantResponse { - // Tenant object. - Tenant tenant = 1; + // Tenant object. + Tenant tenant = 1; - // Created at timestamp. - google.protobuf.Timestamp created_at = 2; + // Created at timestamp. + google.protobuf.Timestamp created_at = 2; - // Last update timestamp. - google.protobuf.Timestamp updated_at = 3; + // Last update timestamp. + google.protobuf.Timestamp updated_at = 3; } message UpdateTenantRequest { - // Tenant object. - Tenant tenant = 1; + // Tenant object. + Tenant tenant = 1; } message DeleteTenantRequest { - // Tenant ID. - string id = 1; + // Tenant ID. + string id = 1; } message ListTenantsRequest { - // Max number of tenants to return in the result-set. - uint32 limit = 1; + // Max number of tenants to return in the result-set. + uint32 limit = 1; - // Offset in the result-set (for pagination). - uint32 offset = 2; + // Offset in the result-set (for pagination). + uint32 offset = 2; - // If set, the given string will be used to search on name. - string search = 3; + // If set, the given string will be used to search on name. + string search = 3; - // If set, filters the result set to the tenants of the user. - // Only global API keys are able to filter by this field. - string user_id = 4; + // If set, filters the result set to the tenants of the user. + // Only global API keys are able to filter by this field. + string user_id = 4; } message ListTenantsResponse { - // Total number of tenants. - uint32 total_count = 1; + // Total number of tenants. + uint32 total_count = 1; - // Result-set. - repeated TenantListItem result = 2; + // Result-set. + repeated TenantListItem result = 2; } message TenantUser { - // Tenant ID (UUID). - string tenant_id = 1; + // Tenant ID (UUID). + string tenant_id = 1; - // User ID (UUID). - string user_id = 2; + // User ID (UUID). + string user_id = 2; - // User is admin within the context of the tenant. - // There is no need to set the is_device_admin and is_gateway_admin flags. - bool is_admin = 3; + // User is admin within the context of the tenant. + // There is no need to set the is_device_admin and is_gateway_admin flags. + bool is_admin = 3; - // User is able to modify device related resources (applications, - // device-profiles, devices, multicast-groups). - bool is_device_admin = 4; + // User is able to modify device related resources (applications, + // device-profiles, devices, multicast-groups). + bool is_device_admin = 4; - // User is able to modify gateways. - bool is_gateway_admin = 5; + // User is able to modify gateways. + bool is_gateway_admin = 5; - // Email (only used on get and when adding a user to a tenant). - string email = 6; + // Email (only used on get and when adding a user to a tenant). + string email = 6; } message TenantUserListItem { - // Tenant ID (UUID). - string tenant_id = 1; + // Tenant ID (UUID). + string tenant_id = 1; - // User ID (UUID). - string user_id = 2; + // User ID (UUID). + string user_id = 2; - // Created at timestamp. - google.protobuf.Timestamp created_at = 3; + // Created at timestamp. + google.protobuf.Timestamp created_at = 3; - // Last update timestamp. - google.protobuf.Timestamp updated_at = 4; + // Last update timestamp. + google.protobuf.Timestamp updated_at = 4; - // Email. - string email = 5; + // Email. + string email = 5; - // User is admin within the context of the tenant. - // There is no need to set the is_device_admin and is_gateway_admin flags. - bool is_admin = 6; + // User is admin within the context of the tenant. + // There is no need to set the is_device_admin and is_gateway_admin flags. + bool is_admin = 6; - // User is able to modify device related resources (applications, - // device-profiles, devices, multicast-groups). - bool is_device_admin = 7; + // User is able to modify device related resources (applications, + // device-profiles, devices, multicast-groups). + bool is_device_admin = 7; - // User is able to modify gateways. - bool is_gateway_admin = 8; + // User is able to modify gateways. + bool is_gateway_admin = 8; } message AddTenantUserRequest { - // Tenant user object. - TenantUser tenant_user = 1; + // Tenant user object. + TenantUser tenant_user = 1; } message GetTenantUserRequest { - // Tenant ID (UUID). - string tenant_id = 1; + // Tenant ID (UUID). + string tenant_id = 1; - // User ID (UUID). - string user_id = 2; + // User ID (UUID). + string user_id = 2; } message GetTenantUserResponse { - // Tenant user object. - TenantUser tenant_user = 1; + // Tenant user object. + TenantUser tenant_user = 1; - // Created at timestamp. - google.protobuf.Timestamp created_at = 2; + // Created at timestamp. + google.protobuf.Timestamp created_at = 2; - // Last update timestamp. - google.protobuf.Timestamp updated_at = 3; + // Last update timestamp. + google.protobuf.Timestamp updated_at = 3; } message UpdateTenantUserRequest { - // Tenant user object. - TenantUser tenant_user = 1; + // Tenant user object. + TenantUser tenant_user = 1; } message DeleteTenantUserRequest { - // Tenant ID (UUID). - string tenant_id = 1; + // Tenant ID (UUID). + string tenant_id = 1; - // User ID (UUID). - string user_id = 2; + // User ID (UUID). + string user_id = 2; } message ListTenantUsersRequest { - // Tenant ID (UUID). - string tenant_id = 1; + // Tenant ID (UUID). + string tenant_id = 1; - // Max number of tenants to return in the result-set. - uint32 limit = 2; + // Max number of tenants to return in the result-set. + uint32 limit = 2; - // Offset in the result-set (for pagination). - uint32 offset = 3; + // Offset in the result-set (for pagination). + uint32 offset = 3; } message ListTenantUsersResponse { - // Total number of tenants. - uint32 total_count = 1; + // Total number of tenants. + uint32 total_count = 1; - // Result-set. - repeated TenantUserListItem result = 2; + // Result-set. + repeated TenantUserListItem result = 2; } diff --git a/chirpstack/migrations/2023-10-19-142614_add_tenant_and_app_tags/down.sql b/chirpstack/migrations/2023-10-19-142614_add_tenant_and_app_tags/down.sql new file mode 100644 index 00000000..f17f14ee --- /dev/null +++ b/chirpstack/migrations/2023-10-19-142614_add_tenant_and_app_tags/down.sql @@ -0,0 +1,2 @@ +alter table application drop column tags; +alter table tenant drop column tags; diff --git a/chirpstack/migrations/2023-10-19-142614_add_tenant_and_app_tags/up.sql b/chirpstack/migrations/2023-10-19-142614_add_tenant_and_app_tags/up.sql new file mode 100644 index 00000000..857ff304 --- /dev/null +++ b/chirpstack/migrations/2023-10-19-142614_add_tenant_and_app_tags/up.sql @@ -0,0 +1,15 @@ +alter table tenant + add column tags jsonb not null default '{}'; + +alter table tenant + alter column tags drop default; + +create index idx_tenant_tags on tenant using gin (tags); + +alter table application + add column tags jsonb not null default '{}'; + +alter table application + alter column tags drop default; + +create index idx_application_tags on application using gin (tags); \ No newline at end of file diff --git a/chirpstack/src/api/application.rs b/chirpstack/src/api/application.rs index bbd3aabb..a6d80c80 100644 --- a/chirpstack/src/api/application.rs +++ b/chirpstack/src/api/application.rs @@ -10,7 +10,7 @@ use super::auth::validator; use super::error::ToStatus; use super::helpers; use crate::certificate; -use crate::storage::application; +use crate::storage::{application, fields}; pub struct Application { validator: validator::RequestValidator, @@ -47,6 +47,7 @@ impl ApplicationService for Application { tenant_id, name: req_app.name.clone(), description: req_app.description.clone(), + tags: fields::KeyValue::new(req_app.tags.clone()), ..Default::default() }; @@ -86,6 +87,7 @@ impl ApplicationService for Application { tenant_id: a.tenant_id.to_string(), name: a.name, description: a.description, + tags: a.tags.into_hashmap(), }), created_at: Some(helpers::datetime_to_prost_timestamp(&a.created_at)), updated_at: Some(helpers::datetime_to_prost_timestamp(&a.updated_at)), @@ -120,6 +122,7 @@ impl ApplicationService for Application { id: app_id, name: req_app.name.to_string(), description: req_app.description.to_string(), + tags: fields::KeyValue::new(req_app.tags.clone()), ..Default::default() }) .await diff --git a/chirpstack/src/api/tenant.rs b/chirpstack/src/api/tenant.rs index 535da9c1..b091b0dd 100644 --- a/chirpstack/src/api/tenant.rs +++ b/chirpstack/src/api/tenant.rs @@ -9,7 +9,7 @@ use chirpstack_api::api::tenant_service_server::TenantService; use super::auth::{validator, AuthID}; use super::error::ToStatus; use super::helpers; -use crate::storage::{tenant, user}; +use crate::storage::{fields, tenant, user}; pub struct Tenant { validator: validator::RequestValidator, @@ -49,6 +49,7 @@ impl TenantService for Tenant { max_gateway_count: req_tenant.max_gateway_count as i32, private_gateways_up: req_tenant.private_gateways_up, private_gateways_down: req_tenant.private_gateways_down, + tags: fields::KeyValue::new(req_tenant.tags.clone()), ..Default::default() }; @@ -89,6 +90,7 @@ impl TenantService for Tenant { max_device_count: t.max_device_count as u32, private_gateways_up: t.private_gateways_up, private_gateways_down: t.private_gateways_down, + tags: t.tags.into_hashmap(), }), created_at: Some(helpers::datetime_to_prost_timestamp(&t.created_at)), updated_at: Some(helpers::datetime_to_prost_timestamp(&t.updated_at)), @@ -128,6 +130,7 @@ impl TenantService for Tenant { max_gateway_count: req_tenant.max_gateway_count as i32, private_gateways_up: req_tenant.private_gateways_up, private_gateways_down: req_tenant.private_gateways_down, + tags: fields::KeyValue::new(req_tenant.tags.clone()), ..Default::default() }) .await diff --git a/chirpstack/src/downlink/data.rs b/chirpstack/src/downlink/data.rs index 721f7ad6..3d1e8f17 100644 --- a/chirpstack/src/downlink/data.rs +++ b/chirpstack/src/downlink/data.rs @@ -443,7 +443,8 @@ impl Data { device_class_enabled: self.device.enabled_class.to_proto().into(), dev_eui: self.device.dev_eui.to_string(), tags: { - let mut tags = (*self.device_profile.tags).clone(); + let mut tags = (*self.application.tags).clone(); + tags.extend((*self.device_profile.tags).clone()); tags.extend((*self.device.tags).clone()); tags }, diff --git a/chirpstack/src/downlink/tx_ack.rs b/chirpstack/src/downlink/tx_ack.rs index e3a6b019..0bde094c 100644 --- a/chirpstack/src/downlink/tx_ack.rs +++ b/chirpstack/src/downlink/tx_ack.rs @@ -441,7 +441,8 @@ impl TxAck { let dp = self.device_profile.as_ref().unwrap(); let dev = self.device.as_ref().unwrap(); - let mut tags = (*dp.tags).clone(); + let mut tags = (*app.tags).clone(); + tags.extend((*dp.tags).clone()); tags.extend((*dev.tags).clone()); let pl = integration_pb::LogEvent { diff --git a/chirpstack/src/maccommand/dev_status.rs b/chirpstack/src/maccommand/dev_status.rs index 2b6f2257..3ef5b1b9 100644 --- a/chirpstack/src/maccommand/dev_status.rs +++ b/chirpstack/src/maccommand/dev_status.rs @@ -36,8 +36,9 @@ pub async fn handle( ) .await?; - let mut tags = (*dp.tags).clone(); - tags.clone_from(&*dev.tags); + let mut tags = (*app.tags).clone(); + tags.extend((*dp.tags).clone()); + tags.extend((*dev.tags).clone()); let rx_time: DateTime = helpers::get_rx_timestamp(&uplink_frame_set.rx_info_set).into(); diff --git a/chirpstack/src/maccommand/notify_new_end_device.rs b/chirpstack/src/maccommand/notify_new_end_device.rs index 23515d46..d5c9d193 100644 --- a/chirpstack/src/maccommand/notify_new_end_device.rs +++ b/chirpstack/src/maccommand/notify_new_end_device.rs @@ -36,7 +36,8 @@ pub async fn handle( device_class_enabled: dev.enabled_class.to_proto().into(), dev_eui: dev.dev_eui.to_string(), tags: { - let mut tags = (*dp.tags).clone(); + let mut tags = (*app.tags).clone(); + tags.extend((*dp.tags).clone()); tags.extend((*dev.tags).clone()); tags }, diff --git a/chirpstack/src/storage/application.rs b/chirpstack/src/storage/application.rs index 2125d0db..3133950e 100644 --- a/chirpstack/src/storage/application.rs +++ b/chirpstack/src/storage/application.rs @@ -16,8 +16,8 @@ use tracing::info; use uuid::Uuid; use super::error::Error; -use super::get_db_conn; use super::schema::{application, application_integration}; +use super::{fields, get_db_conn}; #[derive(Clone, Queryable, Insertable, PartialEq, Eq, Debug)] #[diesel(table_name = application)] @@ -29,6 +29,7 @@ pub struct Application { pub name: String, pub description: String, pub mqtt_tls_cert: Option>, + pub tags: fields::KeyValue, } impl Application { @@ -52,6 +53,7 @@ impl Default for Application { name: "".into(), description: "".into(), mqtt_tls_cert: None, + tags: fields::KeyValue::new(HashMap::new()), } } } @@ -328,6 +330,7 @@ pub async fn update(a: Application) -> Result { application::updated_at.eq(Utc::now()), application::name.eq(&a.name), application::description.eq(&a.description), + application::tags.eq(&a.tags), )) .get_result(&mut c) .map_err(|e| Error::from_diesel(e, a.id.to_string()))?; diff --git a/chirpstack/src/storage/device.rs b/chirpstack/src/storage/device.rs index d05a93e5..94c4d372 100644 --- a/chirpstack/src/storage/device.rs +++ b/chirpstack/src/storage/device.rs @@ -195,9 +195,11 @@ pub async fn create(d: Device) -> Result { tenant::dsl::max_gateway_count, tenant::dsl::private_gateways_up, tenant::dsl::private_gateways_down, + tenant::dsl::tags, )) .inner_join(application::table) .filter(application::dsl::id.eq(&d.application_id)) + .for_update() .first(c)?; let dev_count: i64 = device::dsl::device diff --git a/chirpstack/src/storage/schema.rs b/chirpstack/src/storage/schema.rs index 32595b69..a76bb623 100644 --- a/chirpstack/src/storage/schema.rs +++ b/chirpstack/src/storage/schema.rs @@ -21,6 +21,7 @@ diesel::table! { name -> Varchar, description -> Text, mqtt_tls_cert -> Nullable, + tags -> Jsonb, } } @@ -296,6 +297,7 @@ diesel::table! { max_gateway_count -> Int4, private_gateways_up -> Bool, private_gateways_down -> Bool, + tags -> Jsonb, } } diff --git a/chirpstack/src/storage/tenant.rs b/chirpstack/src/storage/tenant.rs index 3daab72e..154bf35f 100644 --- a/chirpstack/src/storage/tenant.rs +++ b/chirpstack/src/storage/tenant.rs @@ -1,3 +1,5 @@ +use std::collections::HashMap; + use anyhow::Result; use chrono::{DateTime, Utc}; use diesel::dsl; @@ -7,8 +9,8 @@ use tracing::info; use uuid::Uuid; use super::error::Error; -use super::get_db_conn; use super::schema::{tenant, tenant_user, user}; +use super::{fields, get_db_conn}; #[derive(Queryable, Insertable, PartialEq, Eq, Debug, Clone)] #[diesel(table_name = tenant)] @@ -23,6 +25,7 @@ pub struct Tenant { pub max_gateway_count: i32, pub private_gateways_up: bool, pub private_gateways_down: bool, + pub tags: fields::KeyValue, } impl Tenant { @@ -49,6 +52,7 @@ impl Default for Tenant { max_gateway_count: 0, private_gateways_up: false, private_gateways_down: false, + tags: fields::KeyValue::new(HashMap::new()), } } } @@ -145,6 +149,7 @@ pub async fn update(t: Tenant) -> Result { tenant::max_gateway_count.eq(&t.max_gateway_count), tenant::private_gateways_up.eq(&t.private_gateways_up), tenant::private_gateways_down.eq(&t.private_gateways_down), + tenant::tags.eq(&t.tags), )) .get_result(&mut c) .map_err(|e| Error::from_diesel(e, t.id.to_string())) @@ -408,6 +413,7 @@ pub mod test { max_gateway_count: 10, private_gateways_up: true, private_gateways_down: true, + tags: fields::KeyValue::new(HashMap::new()), }; create(t).await.unwrap() } diff --git a/chirpstack/src/uplink/data.rs b/chirpstack/src/uplink/data.rs index 4ff27f3f..72732056 100644 --- a/chirpstack/src/uplink/data.rs +++ b/chirpstack/src/uplink/data.rs @@ -387,7 +387,8 @@ impl Data { let dp = self.device_profile.as_ref().unwrap(); let dev = self.device.as_ref().unwrap(); - let mut tags = (*dp.tags).clone(); + let mut tags = (*app.tags).clone(); + tags.extend((*dp.tags).clone()); tags.extend((*dev.tags).clone()); self.device_info = Some(integration_pb::DeviceInfo { @@ -1142,7 +1143,8 @@ impl Data { device_queue::delete_item(&qi.id).await?; - let mut tags = (*dp.tags).clone(); + let mut tags = (*app.tags).clone(); + tags.extend((*dp.tags).clone()); tags.extend((*dev.tags).clone()); integration::ack_event( diff --git a/chirpstack/src/uplink/join.rs b/chirpstack/src/uplink/join.rs index 24f93b95..8d210fb1 100644 --- a/chirpstack/src/uplink/join.rs +++ b/chirpstack/src/uplink/join.rs @@ -317,7 +317,8 @@ impl JoinRequest { let dp = self.device_profile.as_ref().unwrap(); let dev = self.device.as_ref().unwrap(); - let mut tags = (*dp.tags).clone(); + let mut tags = (*app.tags).clone(); + tags.extend((*dp.tags).clone()); tags.extend((*dev.tags).clone()); self.device_info = Some(integration_pb::DeviceInfo { diff --git a/chirpstack/src/uplink/join_sns.rs b/chirpstack/src/uplink/join_sns.rs index 4440439d..b95bbaba 100644 --- a/chirpstack/src/uplink/join_sns.rs +++ b/chirpstack/src/uplink/join_sns.rs @@ -184,7 +184,8 @@ impl JoinRequest { let dp = self.device_profile.as_ref().unwrap(); let dev = self.device.as_ref().unwrap(); - let mut tags = (*dp.tags).clone(); + let mut tags = (*app.tags).clone(); + tags.extend((*dp.tags).clone()); tags.extend((*dev.tags).clone()); self.device_info = Some(integration_pb::DeviceInfo { diff --git a/ui/src/views/applications/ApplicationForm.tsx b/ui/src/views/applications/ApplicationForm.tsx index 0a0374a4..7b5328b7 100644 --- a/ui/src/views/applications/ApplicationForm.tsx +++ b/ui/src/views/applications/ApplicationForm.tsx @@ -1,5 +1,6 @@ import { Application } from "@chirpstack/chirpstack-api-grpc-web/api/application_pb"; -import { Form, Input, Button } from "antd"; +import { Form, Input, Button, Tabs, Row, Col } from "antd"; +import { MinusCircleOutlined, PlusOutlined } from "@ant-design/icons"; import { onFinishFailed } from "../helpers"; @@ -19,17 +20,66 @@ function ApplicationForm(props: IProps) { app.setName(v.name); app.setDescription(v.description); + // tags + for (const elm of v.tagsMap) { + app.getTagsMap().set(elm[0], elm[1]); + } + props.onFinish(app); }; return (
- - - - - - + + + + + + + + + + + + {(fields, { add, remove }) => ( + <> + {fields.map(({ key, name, ...restField }) => ( + + + + + + + + + + + + + remove(name)} /> + + + ))} + + + + + )} + + + + } + + )} + + +