SpaceAPI v13 vs. v14
122 removals
550 lines
170 additions
604 lines
{
{
"$id": "https://schema.spaceapi.io/13.json",
"$id": "https://schema.spaceapi.io/14.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "SpaceAPI 0.13",
"description": "SpaceAPI v14",
"type": "object",
"type": "object",
"properties": {
"properties": {
"api": {
"api_compatibility": {
"description": "The version of SpaceAPI your endpoint uses",
"description": "The versions your SpaceAPI endpoint supports",
"type": "string",
"type": "array",
"enum": [
"items": {
"0.13"
"type": "string"
]
},
"contains": {
"const": "14"
}
},
},
"space": {
"space": {
"description": "The name of your space",
"description": "The name of your space",
"type": "string"
"type": "string"
},
},
"logo": {
"logo": {
"description": "URL to your space logo",
"description": "URL to your space logo",
"type": "string"
"type": "string"
},
},
"url": {
"url": {
"description": "URL to your space website",
"description": "URL to your space website",
"type": "string"
"type": "string"
},
},
"location": {
"location": {
"description": "Position data such as a postal address or geographic coordinates",
"description": "Position data such as a postal address or geographic coordinates",
"type": "object",
"type": "object",
"properties": {
"properties": {
"address": {
"address": {
"description": "The postal address of your space (street, block, housenumber, zip code, city, whatever you usually need in your country, and the country itself).<br>Examples: <ul><li>Netzladen e.V., Breite Straße 74, 53111 Bonn, Germany</li></ul>",
"description": "The postal address of your space (street, block, housenumber, zip code, city, whatever you usually need in your country, and the country itself).<br>Examples: <ul><li>Netzladen e.V., Breite Straße 74, 53111 Bonn, Germany</li></ul>",
"type": "string"
"type": "string"
},
},
"lat": {
"lat": {
"description": "Latitude of your space location, in degree with decimal places. Use positive values for locations north of the equator, negative values for locations south of equator.",
"description": "Latitude of your space location, in degree with decimal places. Use positive values for locations north of the equator, negative values for locations south of equator.",
"type": "number"
"type": "number"
},
},
"lon": {
"lon": {
"description": "Longitude of your space location, in degree with decimal places. Use positive values for locations east of Greenwich, and negative values for locations west of Greenwich.",
"description": "Longitude of your space location, in degree with decimal places. Use positive values for locations east of Greenwich, and negative values for locations west of Greenwich.",
"type": "number"
"type": "number"
},
"timezone": {
"description": "The timezone the space is located in. It should be formatted according to the <a target=\"_blank\" href=\"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\">TZ database location names</a>.",
"type": "string",
"examples": [
"Europe/Kyiv",
"Antarctica/Palmer"
]
}
}
},
},
"required": [
"required": [
"lat",
"lat",
"lon"
"lon"
]
]
},
},
"spacefed": {
"spacefed": {
"description": "A flag indicating if the hackerspace uses SpaceFED, a federated login scheme so that visiting hackers can use the space WiFi with their home space credentials.",
"description": "A flag indicating if the hackerspace uses SpaceFED, a federated login scheme so that visiting hackers can use the space WiFi with their home space credentials.",
"type": "object",
"type": "object",
"properties": {
"properties": {
"spacenet": {
"spacenet": {
"description": "See the <a target=\"_blank\" href=\"https://spacefed.net/wiki/index.php/Category:Howto/Spacenet\">wiki</a>.",
"description": "See the <a target=\"_blank\" href=\"https://spacefed.net/index.php/Category:Howto/Spacenet\">wiki</a>.",
"type": "boolean"
"type": "boolean"
},
},
"spacesaml": {
"spacesaml": {
"description": "See the <a target=\"_blank\" href=\"https://spacefed.net/wiki/index.php/Category:Howto/Spacesaml\">wiki</a>.",
"description": "See the <a target=\"_blank\" href=\"https://spacefed.net/index.php?title=Spacesaml\">wiki</a>.",
"type": "boolean"
},
"spacephone": {
"description": "See the <a target=\"_blank\" href=\"https://spacefed.net/wiki/index.php/Category:Howto/Spacephone\">wiki</a>.",
"type": "boolean"
"type": "boolean"
}
}
},
},
"required": [
"required": [
"spacenet",
"spacenet",
"spacesaml",
"spacesaml"
"spacephone"
]
]
},
},
"cam": {
"cam": {
"description": "URL(s) of webcams in your space",
"description": "URL(s) of webcams in your space",
"type": "array",
"type": "array",
"items": {
"items": {
"type": "string"
"type": "string"
},
},
"minItems": 1
"minItems": 1
},
},
"stream": {
"description": "A mapping of stream types to stream URLs. If you use other stream types make a <a href=\"https://github.com/spaceapi/schema/pulls\" target=\"_blank\">pull request</a> or prefix yours with <samp>ext_</samp>.",
"type": "object",
"properties": {
"m4": {
"description": "Your mpg stream URL. Example: <samp>{\"mp4\": \"http://example.org/stream.mpg\"}</samp>",
"type": "string"
},
"mjpeg": {
"description": "Your mjpeg stream URL. Example: <samp>{\"mjpeg\": \"http://example.org/stream.mjpeg\"}</samp>",
"type": "string"
},
"ustream": {
"description": "Your ustream stream URL. Example: <samp>{\"ustream\": \"http://www.ustream.tv/channel/hackspsps\"}</samp>",
"type": "string"
}
}
},
"state": {
"state": {
"description": "A collection of status-related data: actual open/closed status, icons, last change timestamp etc.",
"description": "A collection of status-related data: actual open/closed status, icons, last change timestamp etc.",
"type": "object",
"type": "object",
"properties": {
"properties": {
"open": {
"open": {
"description": "A flag which indicates if the space is currently open or closed. The state 'undefined' can be achieved by assigning this field the value 'null' (without the quotes). In most (all?) programming languages this is evaluated to false so that no app should break",
"description": "A flag which indicates whether the space is currently open or closed. The state 'undefined' can be achieved by omitting this field. A missing 'open' property carries the semantics of a temporary unavailability of the state, whereas the absence of the 'state' property itself means the state is generally not implemented for this space. This field is also allowed to explicitly have the value null for backwards compatibility with older schema versions, but this is deprecated and will be removed in a future version.",
"type": [
"type": [
"boolean",
"boolean",
"null"
"null"
]
]
},
},
"lastchange": {
"lastchange": {
"description": "The Unix timestamp when the space status changed most recently",
"description": "The Unix timestamp when the space status changed most recently",
"type": "number"
"type": "number"
},
},
"trigger_person": {
"trigger_person": {
"description": "The person who lastly changed the state e.g. opened or closed the space.",
"description": "The person who lastly changed the state e.g. opened or closed the space",
"type": "string"
"type": "string"
},
},
"message": {
"message": {
"description": "An additional free-form string, could be something like <samp>'open for public'</samp>, <samp>'members only'</samp> or whatever you want it to be",
"description": "An additional free-form string, could be something like <samp>'open for public'</samp>, <samp>'members only'</samp> or whatever you want it to be",
"type": "string"
"type": "string"
},
},
"icon": {
"icon": {
"description": "Icons that show the status graphically",
"description": "Icons that show the status graphically",
"type": "object",
"type": "object",
"properties": {
"properties": {
"open": {
"open": {
"description": "The URL to your customized space logo showing an open space",
"description": "The URL to your customized space logo showing an open space",
"type": "string"
"type": "string"
},
},
"closed": {
"closed": {
"description": "The URL to your customized space logo showing a closed space",
"description": "The URL to your customized space logo showing a closed space",
"type": "string"
"type": "string"
}
}
},
},
"required": [
"required": [
"open",
"open",
"closed"
"closed"
]
]
}
}
},
}
"required": [
"open"
]
},
},
"events": {
"events": {
"description": "Events which happened recently in your space and which could be interesting to the public, like 'User X has entered/triggered/did something at timestamp Z'",
"description": "Events which happened recently in your space and which could be interesting to the public, like 'User X has entered/triggered/did something at timestamp Z'",
"type": "array",
"type": "array",
"items": {
"items": {
"required": [
"required": [
"name",
"name",
"type",
"type",
"timestamp"
"timestamp"
],
],
"type": "object",
"type": "object",
"properties": {
"properties": {
"name": {
"name": {
"description": "Name or other identity of the subject (e.g. <samp>J. Random Hacker</samp>, <samp>fridge</samp>, <samp>3D printer</samp>, …)",
"description": "Name or other identity of the subject (e.g. <samp>J. Random Hacker</samp>, <samp>fridge</samp>, <samp>3D printer</samp>, …)",
"type": "string"
"type": "string"
},
},
"type": {
"type": {
"description": "Action (e.g. <samp>check-in</samp>, <samp>check-out</samp>, <samp>finish-print</samp>, …). Define your own actions and use them consistently, canonical actions are not (yet) specified",
"description": "Action (e.g. <samp>check-in</samp>, <samp>check-out</samp>, <samp>finish-print</samp>, …). Define your own actions and use them consistently, canonical actions are not (yet) specified",
"type": "string"
"type": "string"
},
},
"timestamp": {
"timestamp": {
"description": "Unix timestamp when the event occurred",
"description": "Unix timestamp when the event occurred",
"type": "number"
"type": "number"
},
},
"extra": {
"extra": {
"description": "A custom text field to give more information about the event",
"description": "A custom text field to give more information about the event",
"type": "string"
"type": "string"
}
}
}
}
}
}
},
},
"contact": {
"contact": {
"description": "Contact information about your space. You must define at least one which is in the list of allowed values of the issue_report_channels field.",
"description": "Contact information about your space",
"type": "object",
"type": "object",
"properties": {
"properties": {
"phone": {
"phone": {
"description": "Phone number, including country code with a leading plus sign. Example: <samp>+1 800 555 4567</samp>",
"description": "Phone number, including country code with a leading plus sign",
"type": "string"
"type": "string",
"examples": [
"+1 800 555 4567",
"+41 79 123 45 67"
]
},
},
"sip": {
"sip": {
"description": "URI for Voice-over-IP via SIP. Example: <samp>sip:yourspace@sip.example.org</samp>",
"description": "URI for Voice-over-IP via SIP",
"type": "string"
"type": "string",
"examples": [
"sip:yourspace@sip.example.org"
]
},
},
"keymasters": {
"keymasters": {
"description": "Persons who carry a key and are able to open the space upon request. One of the fields irc_nick, phone, email or twitter must be specified.",
"description": "Persons who carry a key and are able to open the space upon request. One of the fields irc_nick, phone, email or twitter must be specified.",
"type": "array",
"type": "array",
"minItems": 1,
"minItems": 1,
"items": {
"items": {
"type": "object",
"type": "object",
"properties": {
"properties": {
"name": {
"name": {
"description": "Real name",
"description": "Real name",
"type": "string"
"type": "string"
},
},
"irc_nick": {
"irc_nick": {
"description": "Contact the person with this nickname directly in irc if available. The irc channel to be used is defined in the contact/irc field.",
"description": "Contact the person with this nickname directly in irc if available. The irc channel to be used is defined in the contact/irc field.",
"type": "string"
"type": "string"
},
},
"phone": {
"phone": {
"description": "Example: <samp>['+1 800 555 4567','+1 800 555 4544']</samp>",
"description": "Phone number, including country code with a leading plus sign",
"type": "string"
"type": "string",
"examples": [
"+1 800 555 4567",
"+41 79 123 45 67"
]
},
},
"email": {
"email": {
"description": "Email address which can be base64 encoded.",
"description": "Email address which can be base64 encoded",
"type": "string"
"type": "string"
},
},
"twitter": {
"twitter": {
"description": "Twitter username with leading <samp>@</samp>.",
"description": "Twitter username with leading <code>@</code>",
"type": "string",
"examples": [
"@space_api"
]
},
"xmpp": {
"description": "XMPP (Jabber) ID",
"type": "string"
"type": "string"
},
"mastodon": {
"description": "Mastodon username",
"type": "string",
"examples": [
"@ordnung@chaos.social"
]
},
"matrix": {
"description": "Matrix username (including domain)",
"type": "string",
"examples": [
"@user:example.org"
]
}
}
}
}
}
}
},
},
"irc": {
"irc": {
"description": "URL of the IRC channel, in the form <samp>irc://example.org/#channelname</samp>",
"description": "URL of the IRC channel",
"type": "string"
"type": "string",
"examples": [
"irc://example.org/#channelname"
]
},
},
"twitter": {
"twitter": {
"description": "Twitter handle, with leading @",
"description": "Twitter username with leading <code>@</code>",
"type": "string"
"type": "string",
"examples": [
"@space_api"
]
},
"mastodon": {
"description": "Mastodon username",
"type": "string",
"examples": [
"@ordnung@chaos.social"
]
},
},
"facebook": {
"facebook": {
"description": "Facebook account URL.",
"description": "Facebook account URL",
"type": "string"
"type": "string"
},
},
"google": {
"description": "Google services.",
"type": "object",
"properties": {
"plus": {
"description": "Google plus URL.",
"type": "string"
}
}
},
"identica": {
"identica": {
"description": "Identi.ca or StatusNet account, in the form <samp>yourspace@example.org</samp>",
"description": "Identi.ca or StatusNet account, in the form <samp>yourspace@example.org</samp>",
"type": "string"
"type": "string"
},
},
"foursquare": {
"foursquare": {
"description": "Foursquare ID, in the form <samp>4d8a9114d85f3704eab301dc</samp>.",
"description": "Foursquare ID, in the form <samp>4d8a9114d85f3704eab301dc</samp>",
"type": "string"
"type": "string"
},
},
"email": {
"email": {
"description": "E-mail address for contacting your space. If this is a mailing list consider to use the contact/ml field.",
"description": "E-mail address for contacting your space. If this is a mailing list consider to use the contact/ml field.",
"type": "string"
"type": "string"
},
},
"ml": {
"ml": {
"description": "The e-mail address of your mailing list. If you use Google Groups then the e-mail looks like <samp>your-group@googlegroups.com</samp>.",
"description": "The e-mail address of your mailing list. If you use Google Groups then the e-mail looks like <samp>your-group@googlegroups.com</samp>.",
"type": "string"
"type": "string"
},
},
"jabber": {
"xmpp": {
"description": "A public Jabber/XMPP multi-user chatroom in the form <samp>chatroom@conference.example.net</samp>",
"description": "A public Jabber/XMPP multi-user chatroom in the form <samp>chatroom@conference.example.net</samp>",
"type": "string"
"type": "string"
},
},
"issue_mail": {
"issue_mail": {
"description": "A separate email address for issue reports (see the <em>issue_report_channels</em> field). This value can be Base64-encoded.",
"description": "A separate email address for issue reports. This value can be Base64-encoded.",
"type": "string"
"type": "string"
},
"gopher": {
"description": "A URL to find information about the Space in the Gopherspace",
"type": "string",
"examples": [
"gopher://gopher.binary-kitchen.de"
]
},
"matrix": {
"description": "Matrix channel/community for the Hackerspace",
"type": "string",
"examples": [
"#spaceroom:example.org",
"+spacecommunity:example.org"
]
},
"mumble": {
"description": "URL to a Mumble server/channel, as specified in https://wiki.mumble.info/wiki/Mumble_URL",
"type": "string",
"examples": [
"mumble://mumble.example.org/spaceroom?version=1.2.0"
]
}
}
}
}
},
},
"issue_report_channels": {
"description": "This array defines all communication channels where you want to get automated issue reports about your SpaceAPI endpoint from the revalidator. This field is meant for internal usage only and it should never be consumed by any app. At least one channel must be defined. Please consider that when using <samp>ml</samp> the mailing list moderator has to moderate incoming emails or add the sender email to the subscribers. If you don't break your SpaceAPI implementation you won't get any notifications ;-)",
"type": "array",
"items": {
"type": "string",
"enum": [
"email",
"issue_mail",
"twitter",
"ml"
]
},
"minItems": 1
},
"sensors": {
"sensors": {
"description": "Data of various sensors in your space (e.g. temperature, humidity, amount of Club-Mate left, …). The only canonical property is the <em>temp</em> property, additional sensor types may be defined by you. In this case, you are requested to share your definition for inclusion in this specification.",
"description": "Data of various sensors in your space (e.g. temperature, humidity, amount of Club-Mate left, …). The only canonical property is the <em>temp</em> property, additional sensor types may be defined by you. In this case, you are requested to share your definition for inclusion in this specification.",
"type": "object",
"type": "object",
"properties": {
"properties": {
"temperature": {
"temperature": {
"description": "Temperature sensor. To convert from one unit of temperature to another consider <a href=\"http://en.wikipedia.org/wiki/Temperature_conversion_formulas\" target=\"_blank\">Wikipedia</a>.",
"description": "Temperature sensor. To convert from one unit of temperature to another consider <a href=\"http://en.wikipedia.org/wiki/Temperature_conversion_formulas\" target=\"_blank\">Wikipedia</a>.",
"type": "array",
"type": "array",
"items": {
"items": {
"type": "object",
"type": "object",
"properties": {
"properties": {
"value": {
"value": {
"description": "The sensor value",
"description": "The sensor value",
"type": "number"
"type": "number"
},
},
"unit": {
"unit": {
"description": "The unit of the sensor value.",
"description": "The unit of the sensor value",
"type": "string",
"type": "string",
"enum": [
"enum": [
"°C",
"°C",
"°F",
"°F",
"K",
"K",
"°De",
"°De",
"°N",
"°N",
"°R",
"°R",
"°Ré",
"°Ré",
"°Rø"
"°Rø"
]
]
},
},
"location": {
"location": {
"description": "The location of your sensor such as <samp>Outside</samp>, <samp>Inside</samp>, <samp>Ceiling</samp>, <samp>Roof</samp> or <samp>Room 1</samp>.",
"description": "The location of your sensor",
"type": "string"
"type": "string",
"examples": [
"Outside",
"Inside",
"Ceiling",
"Room 1"
]
},
},
"name": {
"name": {
"description": "This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.",
"description": "This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.",
"type": "string"
"type": "string"
},
},
"description": {
"description": {
"description": "An extra field that you can use to attach some additional information to this sensor instance.",
"description": "An extra field that you can use to attach some additional information to this sensor instance",
"type": "string"
"type": "string"
}
}
},
},
"required": [
"required": [
"value",
"value",
"unit",
"unit",
"location"
"location"
]
]
}
}
},
},
"door_locked": {
"door_locked": {
"description": "Sensor type to indicate if a certain door is locked.",
"description": "Sensor type to indicate if a certain door is locked",
"type": "array",
"type": "array",
"items": {
"items": {
"type": "object",
"type": "object",
"properties": {
"properties": {
"value": {
"value": {
"description": "The sensor value",
"description": "The sensor value",
"type": "boolean"
"type": "boolean"
},
},
"location": {
"location": {
"description": "The location of your sensor such as <samp>front door</samp>, <samp>chill room</samp> or <samp>lab</samp>.",
"description": "The location of your sensor",
"type": "string"
"type": "string",
"examples": [
"Front door",
"Chill room",
"Lab"
]
},
},
"name": {
"name": {
"description": "This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.",
"description": "This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.",
"type": "string"
"type": "string"
},
},
"description": {
"description": {
"description": "An extra field that you can use to attach some additional information to this sensor instance.",
"description": "An extra field that you can use to attach some additional information to this sensor instance",
"type": "string"
"type": "string"
}
}
},
},
"required": [
"required": [
"value",
"value",
"location"
"location"
]
]
}
}
},
},
"barometer": {
"barometer": {
"description": "Barometer sensor",
"description": "Barometer sensor",
"type": "array",
"type": "array",
"items": {
"items": {
"type": "object",
"type": "object",
"properties": {
"properties": {
"value": {
"value": {
"description": "The sensor value",
"description": "The sensor value",
"type": "number"
"type": "number"
},
},
"unit": {
"unit": {
"description": "The unit of the sensor value. You should always define the unit though if the sensor is a flag of a boolean type then you can of course omit it.",
"description": "The unit of pressure used by your sensor<br>Note: The <code>hPA</code> unit is deprecated and should not be used anymore. Use the correct <code>hPa</code> unit instead.",
"type": "string",
"type": "string",
"enum": [
"enum": [
"hPa",
"hPA"
"hPA"
]
]
},
},
"location": {
"location": {
"description": "The location of your sensor such as <samp>Outside</samp>, <samp>Inside</samp>, <samp>Ceiling</samp>, <samp>Roof</samp> or <samp>Room 1</samp>.",
"description": "The location of your sensor",
"type": "string"
"type": "string",
"examples": [
"Outside",
"Inside",
"Lab"
]
},
},
"name": {
"name": {
"description": "This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.",
"description": "This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.",
"type": "string"
"type": "string"
},
},
"description": {
"description": {
"description": "An extra field that you can use to attach some additional information to this sensor instance.",
"description": "An extra field that you can use to attach some additional information to this sensor instance",
"type": "string"
"type": "string"
}
}
},
},
"required": [
"required": [
"value",
"value",
"unit",
"unit",
"location"
"location"
]
]
}
}
},
},
"radiation": {
"radiation": {
"description": "Compound radiation sensor. Check this <a rel=\"nofollow\" href=\"https://sites.google.com/site/diygeigercounter/gm-tubes-supported\" target=\"_blank\">resource</a>.",
"description": "Compound radiation sensor. Check this <a rel=\"nofollow\" href=\"https://sites.google.com/site/diygeigercounter/gm-tubes-supported\" target=\"_blank\">resource</a>.",
"type": "object",
"type": "object",
"properties": {
"properties": {
"alpha": {
"alpha": {
"description": "An alpha sensor",
"description": "An alpha sensor",
"type": "array",
"type": "array",
"items": {
"items": {
"type": "object",
"type": "object",
"properties": {
"properties": {
"value": {
"value": {
"description": "Observed counts per minute (ocpm) or actual radiation value. If the value are the observed counts then the dead_time and conversion_factor fields must be defined as well. CPM formula: <div>cpm = ocpm ( 1 + 1 / (1 - ocpm x dead_time) )</div> Conversion formula: <div>µSv/h = cpm x conversion_factor</div>",
"description": "Observed counts per minute (ocpm) or actual radiation value. If the value are the observed counts then the dead_time and conversion_factor fields must be defined as well. CPM formula: <div>cpm = ocpm ( 1 + 1 / (1 - ocpm x dead_time) )</div> Conversion formula: <div>µSv/h = cpm x conversion_factor</div>",
"type": "number"
"type": "number"
},
},
"unit": {
"unit": {
"description": "Choose the appropriate unit for your radiation sensor instance.",
"description": "Choose the appropriate unit for your radiation sensor instance",
"type": "string",
"type": "string",
"enum": [
"enum": [
"cpm",
"cpm",
"r/h",
"r/h",
"µSv/h",
"µSv/h",
"mSv/a",
"mSv/a",
"µSv/a"
"µSv/a"
]
]
},
},
"dead_time": {
"dead_time": {
"description": "The dead time in µs. See the description of the value field to see how to use the dead time.",
"description": "The dead time in µs. See the description of the value field to see how to use the dead time.",
"type": "number"
"type": "number"
},
},
"conversion_factor": {
"conversion_factor": {
"description": "The conversion from the <em>cpm</em> unit to another unit hardly depends on your tube type. See the description of the value field to see how to use the conversion factor. <strong>Note:</strong> only trust your manufacturer if it comes to the actual factor value. The internet seems <a rel=\"nofollow\" href=\"http://sapporohibaku.wordpress.com/2011/10/15/conversion-factor/\" target=\"_blank\">full of wrong copy & pastes</a>, don't even trust your neighbour hackerspace. If in doubt ask the tube manufacturer.",
"description": "The conversion from the <em>cpm</em> unit to another unit hardly depends on your tube type. See the description of the value field to see how to use the conversion factor. <strong>Note:</strong> only trust your manufacturer if it comes to the actual factor value. The internet seems <a rel=\"nofollow\" href=\"http://sapporohibaku.wordpress.com/2011/10/15/conversion-factor/\" target=\"_blank\">full of wrong copy & pastes</a>, don't even trust your neighbour hackerspace. If in doubt ask the tube manufacturer.",
"type": "number"
"type": "number"
},
},
"location": {
"location": {
"description": "The location of your sensor such as <samp>Outside</samp>, <samp>Inside</samp>, <samp>Ceiling</samp>, <samp>Roof</samp> or <samp>Room 1</samp>.",
"description": "The location of your sensor",
"type": "string"
"type": "string",
"examples": [
"Outside",
"Roof",
"Lab"
]
},
},
"name": {
"name": {
"description": "This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.",
"description": "This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.",
"type": "string"
"type": "string"
},
},
"description": {
"description": {
"description": "An extra field that you can use to attach some additional information to this sensor instance.",
"description": "An extra field that you can use to attach some additional information to this sensor instance",
"type": "string"
"type": "string"
}
}
},
},
"required": [
"required": [
"value",
"value",
"unit"
"unit"
]
]
}
}
},
},
"beta": {
"beta": {
"description": "A beta sensor",
"description": "A beta sensor",
"type": "array",
"type": "array",
"items": {
"items": {
"type": "object",
"type": "object",
"properties": {
"properties": {
"value": {
"value": {
"description": "Observed counts per minute (ocpm) or actual radiation value. If the value are the observed counts then the dead_time and conversion_factor fields must be defined as well. CPM formula: <div>cpm = ocpm ( 1 + 1 / (1 - ocpm x dead_time) )</div> Conversion formula: <div>µSv/h = cpm x conversion_factor</div>",
"description": "Observed counts per minute (ocpm) or actual radiation value. If the value are the observed counts then the dead_time and conversion_factor fields must be defined as well. CPM formula: <div>cpm = ocpm ( 1 + 1 / (1 - ocpm x dead_time) )</div> Conversion formula: <div>µSv/h = cpm x conversion_factor</div>",
"type": "number"
"type": "number"
},
},
"unit": {
"unit": {
"description": "Choose the appropriate unit for your radiation sensor instance.",
"description": "Choose the appropriate unit for your radiation sensor instance",
"type": "string",
"type": "string",
"enum": [
"enum": [
"cpm",
"cpm",
"r/h",
"r/h",
"µSv/h",
"µSv/h",
"mSv/a",
"mSv/a",
"µSv/a"
"µSv/a"
]
]
},
},
"dead_time": {
"dead_time": {
"description": "The dead time in µs. See the description of the value field to see how to use the dead time.",
"description": "The dead time in µs. See the description of the value field to see how to use the dead time.",
"type": "number"
"type": "number"
},
},
"conversion_factor": {
"conversion_factor": {
"description": "The conversion from the <em>cpm</em> unit to another unit hardly depends on your tube type. See the description of the value field to see how to use the conversion factor. <strong>Note:</strong> only trust your manufacturer if it comes to the actual factor value. The internet seems <a rel=\"nofollow\" href=\"http://sapporohibaku.wordpress.com/2011/10/15/conversion-factor/\" target=\"_blank\">full of wrong copy & pastes</a>, don't even trust your neighbour hackerspace. If in doubt ask the tube manufacturer.",
"description": "The conversion from the <em>cpm</em> unit to another unit hardly depends on your tube type. See the description of the value field to see how to use the conversion factor. <strong>Note:</strong> only trust your manufacturer if it comes to the actual factor value. The internet seems <a rel=\"nofollow\" href=\"http://sapporohibaku.wordpress.com/2011/10/15/conversion-factor/\" target=\"_blank\">full of wrong copy & pastes</a>, don't even trust your neighbour hackerspace. If in doubt ask the tube manufacturer.",
"type": "number"
"type": "number"
},
},
"location": {
"location": {
"description": "The location of your sensor such as <samp>Outside</samp>, <samp>Inside</samp>, <samp>Ceiling</samp>, <samp>Roof</samp> or <samp>Room 1</samp>.",
"description": "The location of your sensor",
"type": "string"
"type": "string",
"examples": [
"Outside",
"Roof",
"Lab"
]
},
},
"name": {
"name": {
"description": "This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.",
"description": "This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.",
"type": "string"
"type": "string"
},
},
"description": {
"description": {
"description": "An extra field that you can use to attach some additional information to this sensor instance.",
"description": "An extra field that you can use to attach some additional information to this sensor instance",
"type": "string"
"type": "string"
}
}
},
},
"required": [
"required": [
"value",
"value",
"unit"
"unit"
]
]
}
}
},
},
"gamma": {
"gamma": {
"description": "A gamma sensor",
"description": "A gamma sensor",
"type": "array",
"type": "array",
"items": {
"items": {
"type": "object",
"type": "object",
"properties": {
"properties": {
"value": {
"value": {
"description": "Observed counts per minute (ocpm) or actual radiation value. If the value are the observed counts then the dead_time and conversion_factor fields must be defined as well. CPM formula: <div>cpm = ocpm ( 1 + 1 / (1 - ocpm x dead_time) )</div> Conversion formula: <div>µSv/h = cpm x conversion_factor</div>",
"description": "Observed counts per minute (ocpm) or actual radiation value. If the value are the observed counts then the dead_time and conversion_factor fields must be defined as well. CPM formula: <div>cpm = ocpm ( 1 + 1 / (1 - ocpm x dead_time) )</div> Conversion formula: <div>µSv/h = cpm x conversion_factor</div>",
"type": "number"
"type": "number"
},
},
"unit": {
"unit": {
"description": "Choose the appropriate unit for your radiation sensor instance.",
"description": "Choose the appropriate unit for your radiation sensor instance",
"type": "string",
"type": "string",
"enum": [
"enum": [
"cpm",
"cpm",
"r/h",
"r/h",
"µSv/h",
"µSv/h",
"mSv/a",
"mSv/a",
"µSv/a"
"µSv/a"
]
]
},
},
"dead_time": {
"dead_time": {
"description": "The dead time in µs. See the description of the value field to see how to use the dead time.",
"description": "The dead time in µs. See the description of the value field to see how to use the dead time.",
"type": "number"
"type": "number"
},
},
"conversion_factor": {
"conversion_factor": {
"description": "The conversion from the <em>cpm</em> unit to another unit hardly depends on your tube type. See the description of the value field to see how to use the conversion factor. <strong>Note:</strong> only trust your manufacturer if it comes to the actual factor value. The internet seems <a rel=\"nofollow\" href=\"http://sapporohibaku.wordpress.com/2011/10/15/conversion-factor/\" target=\"_blank\">full of wrong copy & pastes</a>, don't even trust your neighbour hackerspace. If in doubt ask the tube manufacturer.",
"description": "The conversion from the <em>cpm</em> unit to another unit hardly depends on your tube type. See the description of the value field to see how to use the conversion factor. <strong>Note:</strong> only trust your manufacturer if it comes to the actual factor value. The internet seems <a rel=\"nofollow\" href=\"http://sapporohibaku.wordpress.com/2011/10/15/conversion-factor/\" target=\"_blank\">full of wrong copy & pastes</a>, don't even trust your neighbour hackerspace. If in doubt ask the tube manufacturer.",
"type": "number"
"type": "number"
},
},
"location": {
"location": {
"description": "The location of your sensor such as <samp>Outside</samp>, <samp>Inside</samp>, <samp>Ceiling</samp>, <samp>Roof</samp> or <samp>Room 1</samp>.",
"description": "The location of your sensor",
"type": "string"
"type": "string",
"examples": [
"Outside",
"Roof",
"Lab"
]
},
},
"name": {
"name": {
"description": "This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.",
"description": "This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.",
"type": "string"
"type": "string"
},
},
"description": {
"description": {
"description": "An extra field that you can use to attach some additional information to this sensor instance.",
"description": "An extra field that you can use to attach some additional information to this sensor instance",
"type": "string"
"type": "string"
}
}
},
},
"required": [
"required": [
"value",
"value",
"unit"
"unit"
]
]
}
}
},
},
"beta_gamma": {
"beta_gamma": {
"description": "A sensor which cannot filter beta and gamma radiation separately.",
"description": "A sensor which cannot filter beta and gamma radiation separately.",
"type": "array",
"type": "array",
"items": {
"items": {
"type": "object",
"type": "object",
"properties": {
"value": {
"description": "Observed counts per minute (ocpm) or actual radiation value. If the value are the observed counts then the dead_time and conversion_factor fields must be defined as well. CPM formula: <div>cpm = ocpm ( 1 + 1 / (1 - ocpm x dead_time) )</div> Conversion formula: <div>µSv/h = cpm x conversion_factor</div>",
"type": "number"
},
"unit": {
"description": "Choose the appropriate unit for your radiation sensor ins