Struct chirpstack_api::api::device_service_client::DeviceServiceClient

pub struct DeviceServiceClient<T> { /* private fields */ }

DeviceService is the service providing API methods for managing devices.

Implementations

impl DeviceServiceClient<Channel>

pub async fn connect<D>(dst: D) -> Result<Self, Error> where
    D: TryInto<Endpoint>,
    D::Error: Into<StdError>, 

Attempt to create a new client by connecting to a given endpoint.

impl<T> DeviceServiceClient<T> where
    T: GrpcService<BoxBody>,
    T::Error: Into<StdError>,
    T::ResponseBody: Body<Data = Bytes> + Send + 'static,
    <T::ResponseBody as Body>::Error: Into<StdError> + Send, 

pub fn new(inner: T) -> Self

pub fn with_interceptor<F>(
    inner: T,
    interceptor: F
) -> DeviceServiceClient<InterceptedService<T, F>> where
    F: Interceptor,
    T::ResponseBody: Default,
    T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>,
    <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync, 

pub fn send_gzip(self) -> Self

Compress requests with gzip.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_gzip(self) -> Self

Enable decompressing responses with gzip.

pub async fn create(
    &mut self,
    request: impl IntoRequest<CreateDeviceRequest>
) -> Result<Response<()>, Status>

Create the given device.

pub async fn get(
    &mut self,
    request: impl IntoRequest<GetDeviceRequest>
) -> Result<Response<GetDeviceResponse>, Status>

Get returns the device for the given DevEUI.

pub async fn update(
    &mut self,
    request: impl IntoRequest<UpdateDeviceRequest>
) -> Result<Response<()>, Status>

Update the given device.

pub async fn delete(
    &mut self,
    request: impl IntoRequest<DeleteDeviceRequest>
) -> Result<Response<()>, Status>

Delete the device with the given DevEUI.

pub async fn list(
    &mut self,
    request: impl IntoRequest<ListDevicesRequest>
) -> Result<Response<ListDevicesResponse>, Status>

Get the list of devices.

pub async fn create_keys(
    &mut self,
    request: impl IntoRequest<CreateDeviceKeysRequest>
) -> Result<Response<()>, Status>

Create the given device-keys.

pub async fn get_keys(
    &mut self,
    request: impl IntoRequest<GetDeviceKeysRequest>
) -> Result<Response<GetDeviceKeysResponse>, Status>

Get the device-keys for the given DevEUI.

pub async fn update_keys(
    &mut self,
    request: impl IntoRequest<UpdateDeviceKeysRequest>
) -> Result<Response<()>, Status>

Update the given device-keys.

pub async fn delete_keys(
    &mut self,
    request: impl IntoRequest<DeleteDeviceKeysRequest>
) -> Result<Response<()>, Status>

Delete the device-keys for the given DevEUI.

pub async fn flush_dev_nonces(
    &mut self,
    request: impl IntoRequest<FlushDevNoncesRequest>
) -> Result<Response<()>, Status>

FlushDevNonces flushes the OTAA device nonces.

pub async fn activate(
    &mut self,
    request: impl IntoRequest<ActivateDeviceRequest>
) -> Result<Response<()>, Status>

Activate (re)activates the device with the given parameters (for ABP or for importing OTAA activations).

pub async fn deactivate(
    &mut self,
    request: impl IntoRequest<DeactivateDeviceRequest>
) -> Result<Response<()>, Status>

Deactivate de-activates the device.

pub async fn get_activation(
    &mut self,
    request: impl IntoRequest<GetDeviceActivationRequest>
) -> Result<Response<GetDeviceActivationResponse>, Status>

GetActivation returns the current activation details of the device (OTAA or ABP).

pub async fn get_random_dev_addr(
    &mut self,
    request: impl IntoRequest<GetRandomDevAddrRequest>
) -> Result<Response<GetRandomDevAddrResponse>, Status>

GetRandomDevAddr returns a random DevAddr taking the NwkID prefix into account.

pub async fn get_metrics(
    &mut self,
    request: impl IntoRequest<GetDeviceMetricsRequest>
) -> Result<Response<GetDeviceMetricsResponse>, Status>

GetMetrics returns the device metrics. Note that this requires a device-profile with codec and measurements configured.

pub async fn get_link_metrics(
    &mut self,
    request: impl IntoRequest<GetDeviceLinkMetricsRequest>
) -> Result<Response<GetDeviceLinkMetricsResponse>, Status>

GetLinkMetrics returns the device link metrics. This includes uplinks, downlinks, RSSI, SNR, etc…

pub async fn enqueue(
    &mut self,
    request: impl IntoRequest<EnqueueDeviceQueueItemRequest>
) -> Result<Response<EnqueueDeviceQueueItemResponse>, Status>

Enqueue adds the given item to the downlink queue.

pub async fn flush_queue(
    &mut self,
    request: impl IntoRequest<FlushDeviceQueueRequest>
) -> Result<Response<()>, Status>

FlushQueue flushes the downlink device-queue.

pub async fn get_queue(
    &mut self,
    request: impl IntoRequest<GetDeviceQueueItemsRequest>
) -> Result<Response<GetDeviceQueueItemsResponse>, Status>

GetQueue returns the downlink device-queue.

Trait Implementations

impl<T: Clone> Clone for DeviceServiceClient<T>

fn clone(&self) -> DeviceServiceClient<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for DeviceServiceClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.