Rename AppID to AppArgs for consistency and clarity

gotthardp · gotthardp · commit d21f7e1ba31d · 2017-02-28T21:53:18.000+01:00
diff --git a/doc/Administration.md b/doc/Administration.md
@@ -58,7 +58,7 @@ For each device, which may connect to your network, you can set:
  * *DevEUI* of the device
  * *Region* that determines the LoRaWAN regional parameters
  * *Application* identifier corresponding to one of the [Handlers](Handlers.md) configured.
- * *AppID*, which is a string with application-specific configuration.
+ * *Arguments*, which is an opaque string with application-specific settings.
  * *AppEUI* and *AppKey*
  * *FCnt Check* to be used for this device
    * *Strict 16-bit* (default) or *Strict 32-bit* indicate a standard compliant counter.
@@ -81,7 +81,7 @@ For each device, which is connected (has a link) to the network, you can set:
  * *DevEUI* of the device
  * *Region* that determines the LoRaWAN regional parameters
  * *Application* identifier corresponding to one of the [Handlers](Handlers.md) configured.
- * *AppID*, which is a string with application-specific configuration.
+ * *Arguments*, which is an opaque string with application-specific settings.
  * *NwkSKey* and *AppSKey*
  * *FCnt Check* to be used for this device (see the Devices section for more explanation).
 
diff --git a/doc/Handlers.md b/doc/Handlers.md
@@ -53,16 +53,16 @@ The `init/1` will be called upon server initialization. It shall return either
 REST API or WebSockets). For more details see
 [Cowboy Routing](https://github.com/ninenines/cowboy/blob/master/doc/src/guide/routing.asciidoc).
 
-### handle_join(DevAddr, App, AppID)
+### handle_join(DevAddr, App, AppArgs)
 
 The `handle_join/3` will be called when a new node joins the network. The function
 shall return either `ok` or `{error, error_description}`.
 
-### handle_rx(DevAddr, App, AppID, RxData)
+### handle_rx(DevAddr, App, AppArgs, RxData)
 The `handle_rx/4` will be called upon reception of a LoRaWAN frame:
   * *DevAddr* is the 4-byte device address
   * *App* is the application name defined in the `sys.config`
-  * *AppID* is an opaque value assigned to the device
+  * *AppArgs* is an opaque value assigned to the device
   * *RxData* is the #rxdata{} record with:
     * *port* number
     * *data* binary
@@ -92,9 +92,9 @@ The function may return:
 
 For example:
 ```erlang
-handle_rx(DevAddr, <<"my-app">>, AppID, #rxdata{last_lost=true}) ->
+handle_rx(DevAddr, <<"my-app">>, AppArgs, #rxdata{last_lost=true}) ->
     retransmit;
-handle_rx(DevAddr, <<"my-app">>, AppID, #rxdata{port=PortIn, data= <<"DataIn">>}) ->
+handle_rx(DevAddr, <<"my-app">>, AppArgs, #rxdata{port=PortIn, data= <<"DataIn">>}) ->
     %% application logic
     %% ...
     {send, #txdata{port=PortOut, data= <<"DataOut">>}}.
diff --git a/doc/WebSockets.md b/doc/WebSockets.md
@@ -10,7 +10,7 @@ URL is used to select both the target device(s) as well as the desired format.
  --------------------|--------------------------------------------------------------------
   /devices/*123*/... | Connects to a device with a DevEUI=*123*.
   /links/*456*/...   | Connects to a link (active node) with a DevAddr=*456*.
-  /groups/*ABC*/...  | Connects to all websocket devices whose **AppID** is set to *ABC*.
+  /groups/*ABC*/...  | Connects to all websocket devices whose **AppArgs** is set to *ABC*.
 
 Multiple parallel connections may be established to one URL.
 When the device sends a frame, all connected clients will receive the application data.
diff --git a/priv/admin/admin.js b/priv/admin/admin.js
@@ -149,7 +149,7 @@ myApp.config(['NgAdminConfigurationProvider', function (nga) {
         nga.field('deveui').label('DevEUI').isDetailLink(true),
         nga.field('region'),
         nga.field('app').label('Application'),
-        nga.field('appid').label('AppID'),
+        nga.field('appid').label('Arguments'),
         nga.field('last_join', 'datetime').label('Last Join'),
         nga.field('link', 'reference')
             .targetEntity(links)
@@ -169,7 +169,7 @@ myApp.config(['NgAdminConfigurationProvider', function (nga) {
             .targetEntity(applications)
             .targetField(nga.field('name'))
             .validation({ required: true }),
-        nga.field('appid').label('AppID'),
+        nga.field('appid').label('Arguments'),
         nga.field('appeui').label('AppEUI')
             .attributes({ placeholder: 'e.g. 0123456789ABCDEF' })
             .validation({ required: true, pattern: '[A-Fa-f0-9]{16}' }),
@@ -221,7 +221,7 @@ myApp.config(['NgAdminConfigurationProvider', function (nga) {
         nga.field('devaddr').label('DevAddr').isDetailLink(true),
         nga.field('region'),
         nga.field('app').label('Application'),
-        nga.field('appid').label('AppID'),
+        nga.field('appid').label('Arguments'),
         nga.field('fcntup', 'number').label('FCnt Up'),
         nga.field('fcntdown', 'number').label('FCnt Down'),
         nga.field('devstat.battery', 'number').label('Battery'),
@@ -241,7 +241,7 @@ myApp.config(['NgAdminConfigurationProvider', function (nga) {
             .targetEntity(applications)
             .targetField(nga.field('name'))
             .validation({ required: true }),
-        nga.field('appid').label('AppID'),
+        nga.field('appid').label('Arguments'),
         nga.field('nwkskey').label('NwkSKey')
             .attributes({ placeholder: 'e.g. FEDCBA9876543210FEDCBA9876543210' })
             .validation({ required: true, pattern: '[A-Fa-f0-9]{32}' }),
diff --git a/src/lorawan_application_handler.erl b/src/lorawan_application_handler.erl
@@ -24,17 +24,17 @@ do_init([Application|Rest], Acc) ->
         Else -> Else
     end.
 
-invoke_init({AppID, {App, Module}}) ->
-    {ok, _Started} = application:ensure_all_started(App),
-    apply(Module, init, [AppID]);
-invoke_init({AppID, Module}) when is_atom(Module) ->
-    apply(Module, init, [AppID]).
+invoke_init({App, {AppName, Module}}) ->
+    {ok, _Started} = application:ensure_all_started(AppName),
+    apply(Module, init, [App]);
+invoke_init({App, Module}) when is_atom(Module) ->
+    apply(Module, init, [App]).
 
-handle_join(DevAddr, App, AppID) ->
-    invoke_handler(handle_join, App, [DevAddr, App, AppID]).
+handle_join(DevAddr, App, AppArgs) ->
+    invoke_handler(handle_join, App, [DevAddr, App, AppArgs]).
 
-handle_rx(DevAddr, App, AppID, RxData) ->
-    invoke_handler(handle_rx, App, [DevAddr, App, AppID, RxData]).
+handle_rx(DevAddr, App, AppArgs, RxData) ->
+    invoke_handler(handle_rx, App, [DevAddr, App, AppArgs, RxData]).
 
 invoke_handler(Fun, App, Params) ->
     {ok, Modules} = application:get_env(plugins),
diff --git a/src/lorawan_application_microchip_mote.erl b/src/lorawan_application_microchip_mote.erl
@@ -16,20 +16,20 @@
 init(_App) ->
     ok.
 
-handle_join(_DevAddr, _App, _AppID) ->
+handle_join(_DevAddr, _App, _AppArgs) ->
     % accept any device
     ok.
 
 % the data structure is explained in
 % Lora_Legacy_Mote_Firmware/Includes/Board/MOTEapp.c:520
-handle_rx(DevAddr, _App, _AppID, #rxdata{data= <<Light:5/binary, Temp:3/binary>>}) ->
+handle_rx(DevAddr, _App, _AppArgs, #rxdata{data= <<Light:5/binary, Temp:3/binary>>}) ->
     lager:debug("PUSH_DATA ~s ~s",[DevAddr, Light, Temp]),
     % display actual time
     {H, M, S} = time(),
     Time = lists:flatten(io_lib:format('~2..0b:~2..0b:~2..0b', [H, M, S])),
     {send, #txdata{port=2, data=list_to_binary(Time)}};
 
-handle_rx(_DevAddr, _App, _AppID, RxData) ->
+handle_rx(_DevAddr, _App, _AppArgs, RxData) ->
     {error, {unexpected_data, RxData}}.
 
 % end of file
diff --git a/src/lorawan_application_semtech_mote.erl b/src/lorawan_application_semtech_mote.erl
@@ -16,18 +16,18 @@
 init(_App) ->
     ok.
 
-handle_join(_DevAddr, _App, _AppID) ->
+handle_join(_DevAddr, _App, _AppArgs) ->
     % accept any device
     ok.
 
 % the data structure is explained in
 % https://github.com/Lora-net/LoRaMac-node/blob/master/src/apps/LoRaMac/classA/LoRaMote/main.c#L207
-handle_rx(DevAddr, _App, _AppID, #rxdata{port=2, data= <<LED, Press:16, Temp:16, _AltBar:16, Batt, _Lat:24, _Lon:24, _AltGps:16>>}) ->
+handle_rx(DevAddr, _App, _AppArgs, #rxdata{port=2, data= <<LED, Press:16, Temp:16, _AltBar:16, Batt, _Lat:24, _Lon:24, _AltGps:16>>}) ->
     lager:debug("PUSH_DATA ~w ~w ~w ~w",[DevAddr, Press, Temp, Batt]),
     % blink with the LED indicator
     {send, #txdata{port=2, data= <<((LED+1) rem 2)>>}};
 
-handle_rx(_DevAddr, _App, _AppID, RxData) ->
+handle_rx(_DevAddr, _App, _AppArgs, RxData) ->
     {error, {unexpected_data, RxData}}.
 
 % end of file
diff --git a/src/lorawan_application_websocket.erl b/src/lorawan_application_websocket.erl
@@ -16,19 +16,19 @@ init(_App) ->
         {"/ws/:type/:name/json", lorawan_ws_frames, [json]}
     ]}.
 
-handle_join(_DevAddr, _App, _AppID) ->
+handle_join(_DevAddr, _App, _AppArgs) ->
     % accept any device
     ok.
 
-handle_rx(DevAddr, _App, AppID, #rxdata{last_lost=true} = RxData) ->
-    send_to_sockets(DevAddr, AppID, RxData),
+handle_rx(DevAddr, _App, AppArgs, #rxdata{last_lost=true} = RxData) ->
+    send_to_sockets(DevAddr, AppArgs, RxData),
     retransmit;
-handle_rx(DevAddr, _App, AppID, #rxdata{port=Port} = RxData) ->
-    send_to_sockets(DevAddr, AppID, RxData),
+handle_rx(DevAddr, _App, AppArgs, #rxdata{port=Port} = RxData) ->
+    send_to_sockets(DevAddr, AppArgs, RxData),
     lorawan_application_handler:send_stored_frames(DevAddr, Port).
 
-send_to_sockets(DevAddr, AppID, RxData) ->
-    Sockets = lorawan_ws_frames:get_processes(DevAddr, AppID),
-    [Pid ! {send, DevAddr, AppID, RxData} || Pid <- Sockets].
+send_to_sockets(DevAddr, AppArgs, RxData) ->
+    Sockets = lorawan_ws_frames:get_processes(DevAddr, AppArgs),
+    [Pid ! {send, DevAddr, AppArgs, RxData} || Pid <- Sockets].
 
 % end of file
diff --git a/src/lorawan_ws_frames.erl b/src/lorawan_ws_frames.erl
@@ -84,17 +84,17 @@ store_frame0(DevAddr, TxData, State) ->
     lorawan_application_handler:store_frame(DevAddr, TxData),
     {ok, State}.
 
-websocket_info({send, _DevAddr, _AppID, #rxdata{data=Data}}, #state{format=raw} = State) ->
+websocket_info({send, _DevAddr, _AppArgs, #rxdata{data=Data}}, #state{format=raw} = State) ->
     {reply, {binary, Data}, State};
-websocket_info({send, DevAddr, _AppID, #rxdata{port=Port, data=Data}}, #state{format=json} = State) ->
+websocket_info({send, DevAddr, _AppArgs, #rxdata{port=Port, data=Data}}, #state{format=json} = State) ->
     Msg = [{devaddr, lorawan_mac:binary_to_hex(DevAddr)}, {port, Port}, {data, lorawan_mac:binary_to_hex(Data)}],
     {reply, {text, jsx:encode(Msg)}, State};
 websocket_info(Info, State) ->
     lager:warning("Unknown info ~w", [Info]),
     {ok, State}.
 
-get_processes(DevAddr, AppID) ->
-    get_processes0({?MODULE, links, DevAddr}) ++ get_processes0({?MODULE, groups, AppID}).
+get_processes(DevAddr, AppArgs) ->
+    get_processes0({?MODULE, links, DevAddr}) ++ get_processes0({?MODULE, groups, AppArgs}).
 
 get_processes0(Group) ->
     case pg2:get_members(Group) of
diff --git a/test/test_forwarder.erl b/test/test_forwarder.erl
@@ -30,7 +30,7 @@ rxpk(Base64Data) ->
 
 push_data(MAC, Data) ->
     {ok, Socket} = gen_udp:open(0, [binary]),
-    Token = crypto:rand_bytes(2),
+    Token = crypto:strong_rand_bytes(2),
     % PUSH_DATA
     ok = gen_udp:send(Socket, "localhost", 1680, <<1, Token:2/binary, 0, MAC/binary, (jsx:encode(Data))/binary>>),
     R = receive
@@ -45,7 +45,7 @@ push_data(MAC, Data) ->
 
 pull_data(MAC) ->
     {ok, Socket} = gen_udp:open(0, [binary]),
-    Token = crypto:rand_bytes(2),
+    Token = crypto:strong_rand_bytes(2),
     % PULL_DATA
     ok = gen_udp:send(Socket, "localhost", 1680, <<1, Token:2/binary, 2, MAC/binary>>),
     receive
