Expose boards as open data at data.grandlyon.com

[lutangar]

See https://github.com/interpretable/api/issues/5#issuecomment-1308545574 for a quick and subjective introduction to AAC. This needs to be rephrase to enter a proper documentation.

If Interpetable boards are to be exposed at https://data.grandlyon.com/ then they should be exposed as OBF files and images hosted there as well. It should also be possible to download an obz (archived version) of these obf files.

Open Board Format (OBF)

By linking the board files, the manifest.json allow self-discoverability :

{
  "format": "open-board-0.1",
  "root": "https://download.data.grandlyon.com/ws/rdata/interpretable/boards/1.obf",
  "paths": {
    "boards": {
      "1": "https://download.data.grandlyon.com/ws/rdata/interpretable/boards/1.obf",
      "2": "https://download.data.grandlyon.com/ws/rdata/interpretable/boards/2.obf"
    },
    "images": { },
    "sounds": { }
  }
}

Example of a board with a link to an hosted image :

{
  "format": "open-board-0.1",
  "id": "1",
  "locale": "fr",
  "url": "http://interpretable.projets.erasme.org/",
  "name": "Interpretable",
  "description_html": "This is just a <b>simple</b> example board I put together.",
  "buttons": [
    {
      "id": "1",
      "image_id": "2",
      "label": "happy",
      "border_color": "rgb(0, 0, 55)",
      "background_color": "rgba(200, 255, 255, 0.2)"
    },
    {
      "id": "2",
      "label": "drinks",
      "image_id": "2"
    },
  ],
  "grid": {
    "rows": 1,
    "columns": 2,
    "order": [
      ["1","2"]
    ]
  },
  "images": [
    {
      "id": "1",
      "url": "https://download.data.grandlyon.com/files/interpretable/attendre_a_l_accueil.png",
      "width": 1024,
      "height": 768,
      "content_type": "image/png"
    }
  ]
}

Resources

Alternative Augmentative Communication

• https://arasaac.org/
• https://lehub.apflab.org/category/communication-alternative-et-amelioree-caa/
• https://opendirective.net/posts/2020-04-17-the-open-communication-symbols-ecosystem/

Open Board Format

• https://www.openaac.org/#two
• https://www.openboardformat.org/docs

:fr: Open Data Grand Lyon

• https://data.grandlyon.com/jeux-de-donnees/subventions-ville-lyon/info
• https://data.grandlyon.com/jeux-de-donnees/orthophotographie-2015-metropole-lyon-format-ecw/donnees

[JeromeGutman]

I think it's a good idea to expose OBF format at data.grandlyon.com, for AAC users. But we should also deliver widespread format, as csv by example.