Difference between revisions of "SpaceAPI"

From Hackerspace ACKspace
Jump to: navigation, search
(SpaceAPI 0.12 -> 0.13)
m (set to completed. Updates still might occur)
(18 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Project
 
{{Project
 +
|Featured=No
 
|State=Completed
 
|State=Completed
−
|Members=Vicarious, CoolePascal, Prodigity
+
|Members=Vicarious, Coolepascal, Prodigity, Da Syntax, xopr, stuiterveer
 
|Description=HackerSpace Status API
 
|Description=HackerSpace Status API
 +
|GitHub=spaceAPI
 
}}
 
}}
−
See [https://hackerspaces.nl/spaceapi/ hackerspaces.nl SpaceAPI website] for details.
+
== synopsis ==
 +
Expose hackerspace information via a <abbr title="JavaScript Object Notation">JSON</abbr> structure.
 +
See [https://spaceapi.net/ spaceapi.net] for details.
  
−
== Done so far: ==
+
== current version ==
 +
The current backend has been made modular for easy maintenance and feature expansion.
 +
The first implemented expansion is temperature sensors.
  
 +
Most of the latest implementation has been done by [[user:Da_Syntax|Da Syntax]] and [[User:Xopr|xopr]] (ask them for details).
 +
 +
Currently, both the new and old system are running in parallel, but some things need to be done before deprecating the old system.
 +
* Update the ackspace.nl/spacestate.php 'widget' which was used on [http://hackerspaces.nl/ hackerspaces.nl] (determine whether this can be removed completely)
 +
* <s>ackspace.nl/status.php</s> now gives a 301 - moved permanently, which is needed because the open space directory of [http://spaceapi.net/directory.json spaceapi.net (JSON)] and its [[GitHub::https://github.com/SpaceApi/OpenSpaceDirectory|GitHub repo]] is outdated; it is superseded by '''[https://spaceapi.fixme.ch/directory.json fixme.ch (JSON)]''' with the latest revision on '''[[GitHub::https://github.com/fixme-lausanne/OpenSpaceDirectory|fixme-lausanne's GitHub repo]]'''
 +
 +
Several systems are tied to the backend:
 +
 +
{| class="wikitable"
 +
! inputs
 +
! category
 +
!
 +
! outputs
 +
! category
 +
|-
 +
| [[Space state]] (switch)
 +
| hardware
 +
|
 +
| [[Telephone_system:Space_state|Space state (telephone system)]]
 +
| software
 +
|-
 +
| [[ESP8266-SpaceState]]
 +
| hardware, firmware
 +
|
 +
| [[Spacestate indicator]] <abbr title="incomplete">/!\</abbr>
 +
| hardware, firmware
 +
|-
 +
| [[Spacestate sensors]] <abbr title="incomplete">/!\</abbr>
 +
| hardware, firmware
 +
|
 +
| [[Mobile Spacestate Indicator]]
 +
| hardware, firmware, software
 +
|-
 +
|
 +
|
 +
|
 +
| [[IRC ACKspace-statusbot]]
 +
| software
 +
|-
 +
|
 +
|
 +
|
 +
| [[SpaceAPIBot]] ([https://telegram.org Telegram])
 +
| software
 +
|-
 +
|
 +
|
 +
|
 +
| [https://github.com/ACKspace/Pebble-ACKspace-app Pebble watch app]
 +
| software
 +
|-
 +
|
 +
|
 +
|
 +
| [[Widget:SpaceAPI]]
 +
| software
 +
|}
 +
 +
Affiliated github repositories:
 +
* [[GitHub::https://github.com/ACKspace/spaceAPI|spaceAPI]]: backend
 +
* [[GitHub::https://github.com/ACKspace/SpaceAPIBot|SpaceAPIBot]]: Telegram bot output
 +
* [[GitHub::https://github.com/ACKspace/esp8266-SpaceAPI|esp8266-SpaceAPI]]: modular implementation on [[ESP8266]] (input/output)
 +
 +
Deprecated implementations:
 +
* [[ESP8266-DS18S20]]: old sensor implementation (pull mechanism)
 +
 +
=== todo ===
 +
* upload database model
 +
* update the [[ESP8266-DS18S20|Dallas temperature probe]] and [[ESP8266-SpaceState|space state]] firmware ([https://github.com/ACKspace/esp8266-SpaceAPI esp8266-SpaceAPI Github repo])
 +
 +
=== 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]]
 +
* <s>First draft after recovery [[Media:esp8266-SpaceAPI-full.tar|esp8266-SpaceAPI-full.tar]]</s> Note that the used JSON parser library will cause heap corruption.
 +
* front page widget is now a real widget
 +
* php backend source online
 +
 +
== old 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)
 
**Content type and Cache-Control headers are now sent
 
**Content type and Cache-Control headers are now sent
Line 13: Line 98:
 
**Now uses state object
 
**Now uses state object
 
**Space state now has a third state; null. (In case of uncertain state)
 
**Space state now has a third state; null. (In case of uncertain state)
−
 
+
* Uploaded it to <s>ackspace.nl/status.php</s> but the URL can be changed if necessary..
−
<pre>
 
−
{
 
−
  "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"
 
−
}
 
−
}
 
−
}
 
−
</pre>
 
−
 
 
−
* Uploaded it to [https://ackspace.nl/status.php 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 ‘*’ ".
 
* 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 [[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) ==
+
[[Category:SpaceAPI]]
−
* 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)
 
−
* <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.
 

Revision as of 11:50, 10 April 2018

Project: SpaceAPI
Featured: No
State Completed
Members Vicarious, Coolepascal, Prodigity, Da Syntax, xopr, stuiterveer
GitHub spaceAPI
Description HackerSpace Status API
Picture
No project picture! Fill in form Picture or Upload a jpeg here

synopsis

Expose hackerspace information via a JSON structure. See spaceapi.net for details.

current version

The current backend has been made modular for easy maintenance and feature expansion. The first implemented expansion is temperature sensors.

Most of the latest implementation has been done by Da Syntax and xopr (ask them for details).

Currently, both the new and old system are running in parallel, but some things need to be done before deprecating the old system.

Several systems are tied to the backend:

inputs category outputs category
Space state (switch) hardware Space state (telephone system) software
ESP8266-SpaceState hardware, firmware Spacestate indicator /!\ hardware, firmware
Spacestate sensors /!\ hardware, firmware Mobile Spacestate Indicator hardware, firmware, software
IRC ACKspace-statusbot software
SpaceAPIBot (Telegram) software
Pebble watch app software
Widget:SpaceAPI software

Affiliated github repositories:

Deprecated implementations:

todo

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
  • First draft after recovery esp8266-SpaceAPI-full.tar Note that the used JSON parser library will cause heap corruption.
  • front page widget is now a real widget
  • php backend source online

old 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)
  • Uploaded it to 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!
Retrieved from "https://ackspace.nl/w/index.php?title=SpaceAPI&oldid=8092"