openconnectivityfoundation / devicemodels

Information of the device specification in machine readable format

devicemodels

© 2016-2021 Open Connectivity Foundation, Inc. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE Open Connectivity Foundation, INC. "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE OR WARRANTIES OF NON-INFRINGEMENT, ARE DISCLAIMED. IN NO EVENT SHALL THE Open Connectivity Foundation, INC. OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

To search which device types exist, and which resource types are mandatory for that device type:

https://openconnectivityfoundation.github.io/devicemodels/docs/index.html

To search which resource types exists:

https://openconnectivityfoundation.github.io/devicemodels/docs/resource.html

devicemodels's Issues

HTML Device Map: Add Enumerations

I think we need to add one more level with the enums.
e.g. use https://github.com/openconnectivityfoundation/devicemodels/blob/master/oic.enumerationmap-content.json
to list the enums that should be used for a specific device.

atomic measurement info

add interpretation of atomic measurements, so that the required and optional fields are also shown in the overview

html pages

add link back to the repository for the html page.
e.g. when entering the "html mode" have an button to go back to the readme.md page of the repo

BZ#3478 Air Conditioner Assistant

pull request to cover a new device type:oic.d.acassistant

Validating Device Map Entries against known Resource Types

The entries in the Device Map for required or optional Resource Types do not validate that the Resource Type provided actually maps to an existing Resource. Investigate whether cross checking the Device Map "rt"s against the entries in the Resource Map can be automated so that mismatches do not occur.