chirpstack_api 3.8.1

ChirpStack Protobuf / gRPC API definitions.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

syntax = "proto3";

package nc;

option go_package = "github.com/brocaar/chirpstack-api/go/v3/nc";
option java_package = "io.chirpstack.api.nc";

import "google/protobuf/empty.proto";
import "gw/gw.proto";


enum MType {
	UNKNOWN = 0;
	JOIN_REQUEST = 1;
	JOIN_ACCEPT = 2;
	UNCONFIRMED_DATA_UP = 3;
	UNCONFIRMED_DATA_DOWN = 4;
	CONFIRMED_DATA_UP = 5;
	CONFIRMED_DATA_DOWN = 6;
	REJOIN_REQUEST = 7;
}


// NetworkControllerService is the server to be implemeted by the network-controller.
service NetworkControllerService {
	// HandleUplinkMetaData handles uplink meta-rata.
	rpc HandleUplinkMetaData(HandleUplinkMetaDataRequest) returns (google.protobuf.Empty) {}

	// HandleDownlinkMetaData handles downlink meta-data.
	rpc HandleDownlinkMetaData(HandleDownlinkMetaDataRequest) returns (google.protobuf.Empty) {}

	// HandleUplinkMACCommand handles an uplink mac-command.
	// This method will only be called in case the mac-command request was
	// enqueued throught the API or when the CID is >= 0x80 (proprietary
	// mac-command range).
	rpc HandleUplinkMACCommand(HandleUplinkMACCommandRequest) returns (google.protobuf.Empty) {}

	// HandleRejectedUplinkFrameSet handles a rejected uplink.
	// And uplink can be rejected in the case the device has not (yet) been
	// provisioned, because of invalid frame-counter, MIC, ...
	rpc HandleRejectedUplinkFrameSet(HandleRejectedUplinkFrameSetRequest) returns (google.protobuf.Empty) {}
}

message HandleUplinkMetaDataRequest {
	// Device EUI (8 bytes).
	bytes dev_eui = 1;

	// TX meta-data.
	gw.UplinkTXInfo tx_info = 2;

	// RX meta-data.
	repeated gw.UplinkRXInfo rx_info = 3;

	// PHYPayload byte count.
	uint32 phy_payload_byte_count = 4;

	// MAC-Command byte count.
	uint32 mac_command_byte_count = 5;

	// Application payload byte count.
	uint32 application_payload_byte_count = 6;

	// Message type.
	MType message_type = 7;
}

message HandleDownlinkMetaDataRequest {
	// Device EUI (8 bytes).
	bytes dev_eui = 1;

	// Multicast Group ID (UUID).
	bytes multicast_group_id = 2;

	// TX meta-data.
	gw.DownlinkTXInfo tx_info = 3;

	// PHYPayload byte count.
	uint32 phy_payload_byte_count = 4;

	// MAC-Command byte count.
	uint32 mac_command_byte_count = 5;

	// Application payload byte count.
	uint32 application_payload_byte_count = 6;

	// Message type.
	MType message_type = 7;

    // Gateway ID.
    bytes gateway_id = 8;
}

message HandleUplinkMACCommandRequest {
	// Device EUI (8 bytes).
	bytes dev_eui = 1;

	// Command identifier (specified by the LoRaWAN specs).
	uint32 cid = 2;

	// MAC-command payload(s).
	repeated bytes commands = 6;
}

message HandleRejectedUplinkFrameSetRequest {
	gw.UplinkFrameSet frame_set = 1;
}