[SOLVED] How does the docu site discover "Things"?

hakan · July 8, 2019, 1:02pm

When I go to the Addons page and search for a binding, sometimes the “Things” supported by that binding is shown (search-as-you-type, do not go the the page of the binding itself yet). So, for example for “hue”, “avm” and many others.

So my pushbullet binding got merged, and is also visible in the addons list, but the Thing(s) provided by the binding is not being shown in the overview. Interestingly, the same is true for the snmp and mail bindings.

Is there some metadata that needs to be created for the search to work?

rlkoshak · July 8, 2019, 7:31pm

@Confectrician any ideas or advice?

Confectrician · July 8, 2019, 8:17pm

Not really,

I think i have found the part where the addons contents get filtered for this search,
but @ysc would be the better one to tell us how it works.

Search seems to be done here:

github.com

openhab/website/blob/master/.vuepress/components/AddonSearch.vue#L297


      return found.join(" and ") + " found"
    },
    results () {
      if (!this.filter) return null
      if (this.filter.length < 3) return null
      return {
        addons: this.addons.filter(p => (p.frontmatter &&
                                          (p.frontmatter.label && p.frontmatter.label.toLowerCase().indexOf(this.filter.toLowerCase()) >= 0) ||
                                          (p.frontmatter.description && p.frontmatter.description.toLowerCase().indexOf(this.filter.toLowerCase()) >= 0) ||
                                          (p.frontmatter.id && p.frontmatter.id.toLowerCase().indexOf(this.filter.toLowerCase()) >= 0))),
        things: this.things.filter(t => t.label.toLowerCase().indexOf(this.filter.toLowerCase()) >= 0 ||
                                        // t.description.toLowerCase().indexOf(this.filter.toLowerCase()) >= 0 ||
                                        t.bindingId.toLowerCase().indexOf(this.filter.toLowerCase()) >= 0)
      }
    }
  }
}
</script>

ysc · July 8, 2019, 10:13pm

The list of things comes from this file:

github.com

openhab/website/blob/master/.vuepress/components/things/things.json

[
  {
    "id": "airquality:aqi",
    "label": "Air Quality",
    "bindingId": "airquality"
  },
  {
    "id": "airvisualnode:avnode",
    "label": "AirVisual Node",
    "bindingId": "airvisualnode"
  },
  {
    "id": "allplay:speaker",
    "label": "AllPlay Speaker",
    "bindingId": "allplay"
  },
  {
    "id": "amazondashbutton:dashbutton",
    "label": "@text/dashButtonLabel",
    "bindingId": "amazondashbutton"

This file has been truncated. show original

It is generated by this script which I run manually from time to time:

github.com

openhab/website/blob/master/crawlthings.rb

# Crawl repositories under a base directory and find things in ESH-INF/thing directories
# TODO: doesn't handle translated labels and descriptions...

require "nokogiri"
require "json"

if (!ARGV[0])
    puts "Usage: crawlthings.rb rootPath"
    puts "Put smarthome, openhab2-addons, org.openhab.binding.zigbee, org.openhab.binding.zwave repos under rootPath"
    exit(1)
end

$rootDir = ARGV[0] + File::SEPARATOR
$things = []
puts "Crawling #{$rootDir}"

$i = 0
Dir.glob($rootDir + "/**/ESH-INF/thing/**/*.xml").each { |file|
    if !(file =~ /test/) then
        xml = Nokogiri::XML(open(file))

This file has been truncated. show original

It needs several repositories (openhab2-addons, zwave, zigbee) to be cloned to do its work, so I didn’t want to make it part of the website build process intiially - I only intended to update this list of things when a new release is out. However this could of course become part of the documentation build since those repositories are cloned anyway to fetch the addons’ READMEs.

hakan · July 9, 2019, 1:56pm

This would be excellent and reduce surprises on the part of contributors