Skip to content

Releases: ssilverman/rdm-schema

0.37.0

10 Sep 20:25
Compare
Choose a tag to compare
0.37.0 Pre-release
Pre-release

Changed

  • Changed "manufacturer_id" to optional.

0.36.0

23 Aug 15:19
Compare
Choose a tag to compare
0.36.0 Pre-release
Pre-release

Added

  • Added a required "manufacturer_id" property to the parameter message. It's a 16-bit value having a minimum of 0 and a maximum of 65535 (0xFFFF).
  • Added a note to the "bit/properties/reserved" description clarifying that absent bits are assumed to be reserved.
  • Added a "Notes on the examples" section to the README. There's currently one subsection: "Manufacturer ID".
  • Added manufacturer ID 0 to all the ESTA examples. See the README for a discussion.

Changed

  • Changed "reservedValue" to "valueIfReserved" for consistency with "bitFieldType/properties/valueForUnspecified".
  • Changed the order of "prefixPower" and "prefixBase" mentions in the description for $defs/integerType/properties/prefixBase. For more clarity, "prefixBase" now precedes "prefixPower".

0.35.0

23 Aug 15:14
d3a0089
Compare
Choose a tag to compare
0.35.0 Pre-release
Pre-release

Added

  • "uint128" and "int128" integer types.

Fixed

  • Renamed DNS_IPV4_NAMESERVER example to DNS_IPV4_NAME_SERVER, per the E1.37-2 spec.
  • Removed a nonexistent GET parameter from OUTPUT_RESPONSE_TIME_DESCRIPTION and MODULATION_FREQUENCY_DESCRIPTION examples.

0.34.0

22 Nov 01:47
Compare
Choose a tag to compare
0.34.0 Pre-release
Pre-release

Added

  • Added a default prefix power of zero.
  • Added command class labels to PARAMETER_DESCRIPTION.
  • Subdevices in responses can now be specified. To support this, subdevices for responses were split into a new type and a new "match" value was added to the enum list.
  • Subdevices were expanded to include ranges and specific values, where a "subdevice" is defined as a value in the range 0x0001-0xFFF0 (1-65520), in addition to the enum words.
  • Added a "TODOs" section to the README.
  • Added a section to the README explaining how missing properties, defaults, and the "default" keyword are related.
  • For those properties having a defined "default" annotation, added a sentence to their description describing what their value should be assumed to be if the property is absent.

Fixed

  • Changed some unsigned fields to signed, in SENSOR_DEFINITION, SENSOR_VALUE, and STATUS_MESSAGES.

0.33.0

13 Sep 17:26
Compare
Choose a tag to compare
0.33.0 Pre-release
Pre-release

Added

  • Added a version and "schemas" path section to the schema $id.
  • Added an "Open questions" top-level section to the README.
  • Added a "Best practices" top-level section to the README that describes how to avoid creating ill-defined messages. This replaces the list from the "Constraints and errors" section.

Changed

  • Capitalized titles in the schema.
  • Updated the descriptions for the maximum byte lengths for strings and bytes. Added a sentence that suggests setting these values if the responder wishes for controllers to limit the number of bytes sent.

0.32.0

01 Sep 03:50
Compare
Choose a tag to compare
0.32.0 Pre-release
Pre-release

Added

  • Added two sections to the "Design notes" section of the README. These replace the "Open questions" section. These are:
    1. Strings and string lengths
    2. Names and displayable strings
  • Added "/$defs/commonPropertiesForNamed" to "refType".

Changed

  • Changed "name" to not be required for "/$defs/bit" and the root.
  • Updated the descriptions for "name" and "displayName" in "/$defs/commonPropertiesForNamed" with some example uses.
  • Improved string and character documentation in the README and the schema.

0.31.0

08 Aug 22:55
Compare
Choose a tag to compare
0.31.0 Pre-release
Pre-release

Added

  • Added "minBytes" to "stringType" for the minimum encoded size in bytes. This adds symmetry.
  • Reference to UTF-8 RFC in the README.
  • Added that characters in strings are defined by JSON (RFC 8259) to the descriptions of "minLength" and "maxLength" in the string type.

Changed

  • "RDM E1.20" -> "ANSI E1.20-202x"
  • Moved "unevaluatedProperties" from each of the types into the referencers of the parent "oneOfTypes".
  • Replaced RFC "https://tools.ietf.org/html" links with "https://www.rfc-editor.org/rfc" links.
  • Updated some descriptions in the schema to use Markdown-style links.

Fixed

  • SHIPPING_LOCK invalid "note" property changed to "notes".

0.30.0

18 Jul 17:58
Compare
Choose a tag to compare
0.30.0 Pre-release
Pre-release

Added

  • Reference to RFC 3696 wherever RFC 1123 is mentioned.

Changed

  • IDN hostnames now refer to RFC 5890 instead of just Punycode.

0.29.0

22 Apr 21:31
Compare
Choose a tag to compare
0.29.0 Pre-release
Pre-release

Added

  • New "Relation to other RDM types and structure" section under "Design notes" in the README. This discusses type mapping.
  • New "References mentioned in the schema" section under "Resources" in the README. This adds all the links mentioned in the schema.
  • README "Resources": Added the schema's canonical URL and a link to its main page.
  • README "Usage notes": New "Constraints and errors" section that describes errors the schema doesn't catch.
  • Added to the "refType" description that it is an error if the reference does not point to an object having one of the types in #/$defs/oneOfTypes, or if there is a circular reference. Updated the README to reflect this.
  • README link to an online validator that can validate Draft 2019-09 schemas.

Changed

Fixed

  • The description for the list-of-fields schema in "command" is now "zero or more" instead of "one or more".

0.28.0

15 Apr 05:17
Compare
Choose a tag to compare
0.28.0 Pre-release
Pre-release

Added

  • Alternative patterns for a hostname to the notes in DNS_HOSTNAME.
  • New "Questions" section in the "Design notes" section of the README.

Changed

  • Added and updated titles and descriptions where appropriate.
  • Using "$comment" values where appropriate.
  • Renamed "unspecifiedValues" to "valueForUnspecified" in "bitFieldType" to remove ambiguity.
  • Renamed those schemas that have a "Type" suffix, that aren't a "type" in the UI sense, to have no "Type" suffix. The suffix "Type" here doesn't mean "type" in the programming language sense. These include: "bit", "command", "labeledBoolean", "labeledInteger", "range", and "subdevices".

Removed

  • The "nameType" schema is now gone. Its functionality is contained in "commonPropertiesForNamed" and isn't needed elsewhere.