Merge branch 'dev'

CHANGELOG.md

@@ -2,11 +2,15 @@
 
 This project uses [Semantic Versioning](http://semver.org/).
 
+
 ## [0.1.0] -- 2015-12-18
 ### Fixed
 - Now blocking our own requests and responses.
+- Corrected `MinMax` return values.
+- Only calculate stats if responses have been received.
 
 ### Added
+- Checking for GreenWall version with API support.
 - Readme and luadoc.
 
 ## 0.1.0-dev -- 2015-12-18

GWSonar.lua

@@ -54,6 +54,7 @@ end
 
 --- Minimum/maximum values from a table.
 -- @param t A table of numeric values.
+-- @return (min, max) - Minimum value, maximum value.
 --
 -- Taken from http://lua-users.org/wiki/SimpleStats .
 --
@@ -68,7 +69,7 @@ function MinMax(t)
         end
     end
 
-    return max, min
+    return min, max
 end
 
 
@@ -92,17 +93,27 @@ function Mean(t)
 end
 
 
+--[[-----------------------------------------------------------------------
+
+API Functions
+
+--]]-----------------------------------------------------------------------
+--
 --- Send a ping request.
 local function Ping()
+
     GWSonar.serial = GWSonar.serial + 1
     GWSonar.sample = {}
     local guid = UnitGUID('player')
     local token = string.format('REQUEST/%s/%04X', guid, GWSonar.serial)
+
     GWSonar.timestamp = GetTime()
     GreenWallAPI.SendMessage('GWSonar', token)
     return token
+
 end
 
+
 --- Generate and process ping responses.
 -- @param addon The sending addon
 -- @param sender The sending player
@@ -121,6 +132,7 @@ local function PingHandler(addon, sender, echo, message)
 
         elseif op == 'RESPONSE' then
 
+            -- Record response times
             local delta = GetTime() - GWSonar.timestamp
             table.insert(GWSonar.sample, delta)
             Write('ping response received from %s, %.3f second(s).', sender, delta)
@@ -152,9 +164,13 @@ function GWSonar_OnLoad(self)
         elseif msg == 'stats' then
 
             local n = #GWSonar.sample
-            local min, max = MinMax(GWSonar.sample)
-            local avg = Mean(GWSonar.sample)
-            Write('%d response(s); min/avg/max = %.3f/%.3f/%.3f', n, min, avg, max)
+            if n > 0 then
+                local min, max = MinMax(GWSonar.sample)
+                local avg = Mean(GWSonar.sample)
+                Write('%d response(s); min/avg/max = %.3f/%.3f/%.3f', n, min, avg, max)
+            else
+                Write('No responses')
+            end
 
         end
 
@@ -174,7 +190,12 @@ function GWSonar_OnEvent(self, event, ...)
 
     elseif event == 'PLAYER_ENTERING_WORLD' then  
 
-        GreenWallAPI.AddMessageHandler(PingHandler, 'GWSonar', 0)
+        -- Check to ensure GreenWall is loaded and the installed version 
+        -- supports the API.
+        if IsAddOnLoaded('GreenWall') and GreenWallAPI ~= nil then
+            GreenWallAPI.AddMessageHandler(PingHandler, 'GWSonar', 0)
+            Write('installed ping handler.')
+        end
 
     end
 

GWSonar.toc

@@ -2,11 +2,11 @@
 ## Title: GWSonar
 ## Notes: A demonstration of the GreenWall add-on communication API.
 ## Author: Mark Rogaski <stigg@aie-guild.org>
-## Version: 0.1.0-alpha
+## Version: 0.1.0
 ## URL: https://github.com/AIE-Guild/GWSonar
 ## DefaultState: enabled
 ## X-Category: Guild
-## X-Date: 2015-12-18
+## X-Date: 2015-12-20
 
 GWSonar.lua
 GWSonar.xml