"Tick tick tickety means run your ass out of there..."

TICK-TICK-TICKETY v 0.1

Tick-tick-tickety is a server-based application that implements a REST protocol to store & retrieve readings taken from Geiger Counters.

The primary purpose of this is to make it easier to syndicate & share geiger counter information. The protocol being used is undergoing development.

A second (eventual) purpose is to make it easier to understand WHERE the information is coming from, hopefully allowing us to build a web of trust (rather than blind trust in figures posted on the Internet)

This program is licenced under the GPL3. It's free - as in freedom. It also has no warranty. I am not a Nuclear Engineer; be warned.

This program could not have been done without the kind assistance of the Tokyo Hackerspace.

CURRENT STATE OF PROTOCOL

RETRIEVE INFORMATION

• Return the raw geiger counter readings for tokyo for the week

    URL://get/Tokyo/    

• Return the average geiger counter readings for tokyo for the week

    URL://get/Tokyo/average/    

• Return the median geiger counter readings for tokyo for the week

    URL://get/Tokyo/median/ 

• Return the raw geiger counter readings for tokyo from YYYY-MM-DD

    URL://get/Tokyo/from/YYYY-MM-DD/    

• Return the raw geiger counter readings for tokyo until YYYY-MM-DD

    URL://get/Tokyo/to/YYYY-MM-DD/  

• Return the raw alpha particle geiger counter readings for Tokyo

    URL://get/Tokyo/alpha/  

• Return the raw beta particle geiger counter readings for Tokyo

    URL://get/Tokyo/beta/   

• Return the raw gamma particle geiger counter readings for Tokyo

    URL://get/Tokyo/gamma/  

All of these commands can be mixed together (where it makes sense). For instance:

• Return an average all of the alpha particle geiger counter data from YYYY-MM-DD until the present

    URL://get/Tokyo/alpha/from/YYYY-MM-DD/average/

ADD INFORMATION

• Add your geiger counter

    URL://post/detector/new/

  You must send a POST command to the URL above. This must contain all the required information below. If you do not include all required information, your addition will be rejected.

  Required Information

  • nickname
    • Slug, 8-12 characters
    • this will be used in the URL to show the readings from the detector
  • password
    • 8 characters minimum.
    • Used when posting new readings.
  • cityName
    • The name of the city
  • insideOutside
    • Is it an interior/exterior detector?
    • Valid values are inside and outside
  • countPerMicrosievert
    • The ratio of Counts to one Microsievert
    • Used to convert your CPM data into MicroS / Hr.

  Optional

  • district
    • English please
    • Something to improve the positional understanding. "Nakano" in Tokyo, for example.
  • address
    • Something that can be read by Google Maps please. That means, enter in Japanese characters for a Japanese address, etc..
  • latitude
    • Please use the same units Google Maps uses.
  • longitude
    • Please use the same units Google Maps uses.
  • altitude
    • meters
  • email
    • a place where we can contact you.
  • twitter
    • a twitter account associated with you or your geiger counter.
  • description
    • A few paragraphs explaining your setup for anyone who is curious.

  Return on Success

  You will receive a "201 Created" message with a link to a list of all readings your geiger counter has uploaded.

  Return on Username Already Exists

  You will receive a "403 Forbidden" error message.

  Return on missing data

  You will receive a "400 Bad Request" error message.

  Return on invalid password value

  You will receive a "400 Bad Request" error message.

  Return on invalid insideOutside value

  You will receive a "400 Bad Request" error message.

  Return on invalid countPerMicrosievert value

  You will receive a "400 Bad Request" error message.

  Return on Failure

  You will receive a "403 Forbidden" error message.

• Recalibrate your geiger counter

    URL://post/detector/recalibrate/

  You must send a POST command to the URL above. This must contain all the required information below. Your old calibration settings will be disabled. Old data will continue to use your old calibration settings.

  Required Information

  • nickname
  • password
  • countPerMicrosievert

  Return on Success

  You will receive a "200 OK" response, with a message indicating success.

  Return on Username/Password Failure

  You will receive a "401 Unauthorized" error message.

  Return on missing data

  You will receive a "400 Bad Request" error message.

  Return on invalid countPerMicrosievert value

  You will receive a "400 Bad Request" error message.

  Return on DatabaseFailure

  You will receive a "500 Internal Server Error" error message.

If you think it is all wrong, please feel free to point out my foibles. Arigato.