Difference between revisions of "SpaceAPI"

From Hackerspace ACKspace
Jump to: navigation, search
(SpaceAPI 0.12 -> 0.13)
(added soon-to-be-new version)
Line 1: Line 1:
 
{{Project
 
{{Project
|State=Completed
+
|State=Active
|Members=Vicarious, CoolePascal, Prodigity
+
|Members=Vicarious, CoolePascal, Prodigity, Da Syntax, xopr
 
|Description=HackerSpace Status API
 
|Description=HackerSpace Status API
 
}}
 
}}
 
See [https://hackerspaces.nl/spaceapi/ hackerspaces.nl SpaceAPI website] for details.
 
See [https://hackerspaces.nl/spaceapi/ hackerspaces.nl SpaceAPI website] for details.
  
== Done so far: ==
+
== current version ==
  
 
* Updated JSON object to become SpaceAPI 0.13 compliant (see status.php)
 
* Updated JSON object to become SpaceAPI 0.13 compliant (see status.php)
Line 60: Line 60:
 
* Added the JSON object to the existing [[Space state]] PHP script. Thanks [[User:Coolepascal|CoolePascal]] for the help with the PHP stuff!
 
* Added the JSON object to the existing [[Space state]] PHP script. Thanks [[User:Coolepascal|CoolePascal]] for the help with the PHP stuff!
  
== To do list: (Optional) ==
+
== new version ==
* I created and uploaded really simple [https://ackspace.nl/icon/open.png open] & [https://ackspace.nl/icon/closed.png closed] icons so they won't give HTTP 404 errors, improved icons are welcome! -- [[User:Vicarious|Vicarious]] 12:37, 9 December 2011 (CET)
+
[[user:Da Syntax]] and [[User:Xopr|xopr]] are working on a new implementation of the API. This enables us to add sensors and other parts of the [https://hackerspaces.nl/spaceapi/ official API] as well.
* <del>From the SpaceAPI website: "Additionally, it might be beneficial to add a ‘Cache-Control’ header with a value of ‘no-cache’, to prevent browser caches from retaining old data."</del> Done.
+
 
 +
=== done ===
 +
* created database for space state (log) and sensor values
 +
* new php code online (currently running parallel with the old version)
 +
* created new [[ESP8266-SpaceState|space state]] hardware interface using the [[ESP8266]] which connects to the same old [[space state|switch]]
 +
 
 +
=== todo ===
 +
* implement the temperature backend (PHP/MySQL)
 +
* update the [[ESP8266-DS18S20|Dallas temperature probe]] and [[ESP8266-SpaceState|space state]] firmware
 +
* update this wiki page with the sources
 +
* change the front page iframe into a real widget ({{#Widget:SpaceAPI
 +
|url=https://ackspace.nl/spaceAPI
 +
|interval=10
 +
}})

Revision as of 11:11, 20 July 2015

Project: SpaceAPI
Featured:
State Active
Members Vicarious, CoolePascal, Prodigity, Da Syntax, xopr
GitHub No GitHub project defined. Add your project here.
Description HackerSpace Status API
Picture
No project picture! Fill in form Picture or Upload a jpeg here

See hackerspaces.nl SpaceAPI website for details.

current version

  • Updated JSON object to become SpaceAPI 0.13 compliant (see status.php)
    • Content type and Cache-Control headers are now sent
    • Now uses location object
    • Now uses state object
    • Space state now has a third state; null. (In case of uncertain state)
{
  "api":"0.13",
  "space":"ACKspace",
  "logo":"https://ackspace.nl/ACKspace.150px.png",
  "url":"https://ackspace.nl/",
  "location":{
    "address":"Kloosterweg 1, 6412 CN Heerlen, The Netherlands",
    "lat":50.892665,
    "lon":5.971104
  },
  "issue_report_channels":[
    "email"
  ],
  "feeds":{
    "calendar":{
      "type": "text/calendar",
      "url": "http://www.google.com/calendar/ical/f3j6egtm35u2v027rog3sob7gk%40group.calendar.google.com/public/basic.ics"
    }
  },
  "contact":{
    "email":"contact@ackspace.nl",
    "irc":"irc://freenode/#ACKspace",
    "keymaster":[
      "31457112345, extension 1333"
    ],
    "ml":"info@lists.ackspace.nl",
    "phone":"31457112345",
    "sip":"31457112345@sip1.budgetphone.nl",
    "twitter":"@ACKspace"
  },"state":{
	"open":true,
	"message":"open for public",
	"lastchange":1415742805,
	"icon":{
		"open":"https://ackspace.nl/icon/open.png",
		"closed":"https://ackspace.nl/icon/closed.png"
	}
}
}
  • Uploaded it to https://ackspace.nl/status.php but the URL can be changed if necessary..
  • From the SpaceAPI website: "In order to be able to retrieve the object from within a javascript sandbox, the server of the JSON object should set the ‘Access-Control-Allow-Origin’ header with a value of ‘*’ ".
  • Added the JSON object to the existing Space state PHP script. Thanks CoolePascal for the help with the PHP stuff!

new version

user:Da Syntax and xopr are working on a new implementation of the API. This enables us to add sensors and other parts of the official API as well.

done

  • created database for space state (log) and sensor values
  • new php code online (currently running parallel with the old version)
  • created new space state hardware interface using the ESP8266 which connects to the same old switch

todo

  • implement the temperature backend (PHP/MySQL)
  • update the Dallas temperature probe and space state firmware
  • update this wiki page with the sources
  • change the front page iframe into a real widget ( )