Solar Clock - filled out README file

apps.json

@@ -298,7 +298,9 @@
       {"name":"solar_location.js","url":"solar_location.js"},
       {"name":"solar_math_utils.js","url":"solar_math_utils.js"},
       {"name":"solar_loc.Reykjavik.json","url":"solar_loc.Reykjavik.json"},
+      {"name":"solar_loc.HongKong.json","url":"solar_loc.HongKong.json"},
       {"name":"solar_loc.Honolulu.json","url":"solar_loc.Honolulu.json"},
+      {"name":"solar_loc.Rio.json","url":"solar_loc.Rio.json"},
       {"name":"solar_loc.Tokyo.json","url":"solar_loc.Tokyo.json"}
     ]
   },

apps/solarclock/README.md

@@ -2,26 +2,76 @@
 
 ## Introduction
 
-Ever wondered when Sunset really is, what time will it hit? When the Sun will be highest in the sky? When you phone your friend in another country, you can easily find the time, but is it light where they are? The solar clock gives you a pictoral view of the day. It also gives you the opportunity to get the same view on another city in another timezone.
+Using your current or chosen location the solar watch face shows the Sun's sky position, time and date. Also allows you to wind backwards and forwards in time to see the sun's position
 
 ## Usage
 
+## Choosing the locations from the upload page
 
+Please use the webpage to choose the locations you wish to use:
 
-### Uploading the clock
+- GPS location will use watches GPS to find your location
+- All other entries on the list are popular preset locations
 
+### First use of the clock
 
+After the initial upload the clock will look as follows, if you have chosen the GPS location. Please wait (and go outside) so that the GPS can fix your position
+
+![01-screen-initial-load](01-screen-initial-load.png)
+
+Once the GPS has located your position all the fields will fill out as shown in the next section
 
 ### Reading the clock through the day
 
+#### General Layout
+
+The clock face's layout is as follows:
+
+![02-screen-layout](02-screen-layout.png)
+
+- Whilst using you current local GPS location the location name is left blank. Whilst using a named location this field will be filled in
+
+#### Sun Views through the day
+
+##### Night
+
+During the night the sun will be show as a black circle
+
+![03-night-view](03-night-view.png)
+
+##### Dawn
+
+Around dawn the black sun will turn into the dawn sun with a blue sky background
+
+![04-dawn-view](04-dawn-view.png)
+
+##### Midday
+
+Around midday the corona will surround the sun
+
+
+
+![05-midday-view](05-midday-view.png)
+
+
+
+##### Sunset
+
+At sunset the sun will go sunset red and the surrounding sky with a sunset sky
+
+![06-sunset-view](06-sunset-view.png)
+
 ### Button 3
-Change Location
+
+Location Change: The clock will change to the appropriate timezone and GPS of the next location by pressing button 3. After all the locations have been selected the first item will be returned to.
 
 ### Button 4 and 5
-Move Time backwards and forwards
+Button 4 (left side of screen) will move the sun backwards in time and button 5 will move the sun forwards in time
+
+![07-offsetting-time](07-offsetting-time.png)
 
 ### Button 1
-Rest to now
+Pressing Button 1 by itself will change the offset time back to now
 
 ## Further Details
 For further details of design and working please visit [The Project Page]( https://adrianwkirk.notion.site/Solar-Clock-a2b6268075a6481686b86ecc2094dc14)

apps/solarclock/custom.html

@@ -21,8 +21,10 @@
         
       var locations=[
           {name:"GPS Location", shortname:"local"},
+          {name:"Hong Kong", shortname:"HongKong"},
           {name:"Honolulu", shortname:"Honolulu"},
           {name: "Reykjavik", shortname:"Reykjavik"},
+          {name: "Rio", shortname:"Rio"},
           {name:"Tokyo", shortname:"Tokyo"},
       ];
       var selected_locations = ["local"];

apps/solarclock/solar_clock.js

@@ -113,12 +113,14 @@ function draw_sun(now, day_info) {
 }
 
 function clear_sun(){
-  g.setColor(screen_info.screen_bg_color[0],screen_info.screen_bg_color[1],screen_info.screen_bg_color[2]);
-  g.fillRect(img_info.x,img_info.y,img_info.x+img_width,img_info.y + img_width);
-  GraphicUtils.draw_cosine(img_info.x - 4,
-      img_info.x + img_width + 4,
-      COSINE_COLOUR,
-      screen_info);
+  if(img_info.x != null && img_info.y != null) {
+    g.setColor(screen_info.screen_bg_color[0], screen_info.screen_bg_color[1], screen_info.screen_bg_color[2]);
+    g.fillRect(img_info.x, img_info.y, img_info.x + img_width, img_info.y + img_width);
+    GraphicUtils.draw_cosine(img_info.x - 4,
+        img_info.x + img_width + 4,
+        COSINE_COLOUR,
+        screen_info);
+  }
   GraphicUtils.draw_sunrise_line(HORIZON_COLOUR, day_info, screen_info);
   screen_info.sun_x = null;
   screen_info.sun_y = null;

apps/solarclock/solar_loc.HongKong.json

@@ -0,0 +1,4 @@
+{
+  "coordinates": [114.16111345264378,22.287282159272756],
+  "utc_offset": 8
+}

apps/solarclock/solar_loc.Rio.json

@@ -0,0 +1,4 @@
+{
+"coordinates": [-43.21054084734106,-22.95169863661847],
+"utc_offset": -3
+}

apps/solarclock/solar_locations.json

@@ -1 +1 @@
-["local","Tokyo","Reykjavik","Honolulu"]
+["local","HongKong","Tokyo","Reykjavik","Rio","Honolulu"]