Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add new schema group "winches" #601

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

preeve9534
Copy link

Motivation

  1. The next release of the N2K specification will include three new Windlass Network Messages PGNs (see this Technical Bulletin.
  2. The Signal K specification has no framework for windlass data.

Proposal

  1. Accept that a windlass is a type of winch (as is a capstan and maybe even hoist) and focus this discussion on supporting winches as a top-level group in Signal K.
  2. Accept that we model the winches group structure simply as winches.id, where id is an arbitrary identifier (in the case of an N2K connected winch this would be the installation's N2K instance number).
  3. Take this draft pull request as an RFC which will allow refinement of the detail of how we represent winch data in Signal K.

Straw man

Windlass identity

Common to all winches and just like some other installation identities in Signal K.

identity {
  name:
  location:
  dateInstalled:
  manufacturer {
    name:
    model:
    URL:
  }
}

Winch properties

Common to all winches.

type: [ "capstan" | "generic" | "hoist" | "windlass" ]
state: [ "deploying" | "retrieving" | "stopped" ] // what the winch is currently doing
speed: n, n>=1 // logical speed - a meta object may map this into the physical values
inService: [ "no" | "yes" ] // whether or not the winch is available for use
lastOperation: { // changes when state and or speed change
  direction: [ "deploy" | "retrieve" ]
  speed: n, n>=1
  duration: s
}
meta: { // static winch data
  availableSpeeds: [
    {
      id: n,n>=1,
      rate: m/s
    }
  ]
  powerType: [ "electrical" | "hydraulic" | "manual" ]
  spoolDimensions: {
    diameter: m
    length: m
  }
}

Windlass and capstan properties

Additional properties for windlasses and capstans.

deploymentState: [ "docked" | "nearlyDocked" | "deployed" | "fullyDeployed" ]
rodeType: [ "rope" | "chain" ]
rodeCounter: m
lineSpeed: m/s

This draft pull request includes a very draft winches.json that reflects the straw man for those who like that sort of thing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant