openc3-cosmos-tool-docs 6.9.1 → 6.9.2

data/tools/staticdocs/assets/js/f75a5f33.f16b6dd5.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["3956"],{2888:function(e,s,t){t.r(s),t.d(s,{frontMatter:()=>a,toc:()=>c,default:()=>d,metadata:()=>i,assets:()=>l,contentTitle:()=>r});var i=JSON.parse('{"id":"configuration/limits-response","title":"Limits Response","description":"Custom code invoked when a item with limits changes state","source":"@site/docs/configuration/limits-response.md","sourceDirName":"configuration","slug":"/configuration/limits-response","permalink":"/tools/staticdocs/docs/configuration/limits-response","draft":false,"unlisted":false,"editUrl":"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/limits-response.md","tags":[],"version":"current","sidebarPosition":11,"frontMatter":{"sidebar_position":11,"title":"Limits Response","description":"Custom code invoked when a item with limits changes state","sidebar_custom_props":{"myEmoji":"\u26A0\uFE0F"}},"sidebar":"defaultSidebar","previous":{"title":"Processors","permalink":"/tools/staticdocs/docs/configuration/processors"},"next":{"title":"Tables","permalink":"/tools/staticdocs/docs/configuration/table"}}'),n=t(7259),o=t(677);let a={sidebar_position:11,title:"Limits Response",description:"Custom code invoked when a item with limits changes state",sidebar_custom_props:{myEmoji:"\u26A0\uFE0F"}},r="Overview",l={},c=[{value:"Creating a Limits Response",id:"creating-a-limits-response",level:2},{value:"call",id:"call",level:3},{value:"Apply Conversion",id:"apply-conversion",level:3}];function m(e){let s={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.header,{children:(0,n.jsx)(s.h1,{id:"overview",children:"Overview"})}),"\n",(0,n.jsxs)(s.p,{children:["A limits response is custom code which can respond to a telemetry item changing limits states (red, yellow, green or blue). To apply a limits response to a telemetry item you use the ",(0,n.jsx)(s.a,{href:"/docs/configuration/telemetry#limits_response",children:"LIMITS_RESPONSE"})," keyword."]}),"\n",(0,n.jsx)(s.h2,{id:"creating-a-limits-response",children:"Creating a Limits Response"}),"\n",(0,n.jsxs)(s.p,{children:["You can easily create a limits response by using the ",(0,n.jsx)(s.a,{href:"/docs/getting-started/generators#limits-response-generator",children:"Limits Response Code Generator"}),". To generate a limits response you must be inside an existing COSMOS plugin. The generator takes both a target name and the limits response name. For example if your plugin is called ",(0,n.jsx)(s.code,{children:"openc3-cosmos-gse"})," and you have an existing target named ",(0,n.jsx)(s.code,{children:"GSE"}),":"]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-bash",children:"openc3-cosmos-gse % openc3.sh cli generate limits_response GSE abort --python\nLimits response targets/GSE/lib/abort_limits_response.py successfully generated!\nTo use the limits response add the following to a telemetry item:\n  LIMITS_RESPONSE abort_limits_response.py\n"})}),"\n",(0,n.jsxs)(s.p,{children:["Note: To create a Ruby conversion simply replace ",(0,n.jsx)(s.code,{children:"--python"})," with ",(0,n.jsx)(s.code,{children:"--ruby"})]}),"\n",(0,n.jsxs)(s.p,{children:["This creates a limits response called ",(0,n.jsx)(s.code,{children:"abort_limits_response.py"})," at ",(0,n.jsx)(s.code,{children:"targets/GSE/lib/abort_limits_response.py"}),". The code which is generated looks like the following:"]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-python",children:'from openc3.packets.limits_response import LimitsResponse\nfrom openc3.api import *\n\nclass AbortLimitsResponse(LimitsResponse):\n    # @param packet [Packet] Packet the limits response is assigned to\n    # @param item [PacketItem] PacketItem the limits response is assigned to\n    # @param old_limits_state [Symbol] Previous value of the limit. One of nil,\n    #   "GREEN_HIGH", "GREEN_LOW", "YELLOW", "YELLOW_HIGH", "YELLOW_LOW",\n    #   "RED", "RED_HIGH", "RED_LOW". nil if the previous limit state has not yet\n    #   been established.\n    def call(self, packet, item, old_limits_state):\n        # Take action based on the current limits state\n        # Delete any of the case lines that do not apply or you don\'t care about\n        match item.limits.state:\n            case "RED_HIGH":\n                # Take action like sending a command:\n                # cmd("TARGET SAFE")\n                pass\n            case "RED_LOW":\n                pass\n            case "YELLOW_LOW":\n                pass\n            case "YELLOW_HIGH":\n                pass\n            # GREEN limits are only available if a telemetry item has them defined\n            # COSMOS refers to these as "operational limits"\n            # See https://docs.openc3.com/docs/configuration/telemetry#limits\n            case "GREEN_LOW":\n                pass\n            case "GREEN_HIGH":\n                pass\n            # :RED and :YELLOW limits are triggered for STATES with defined RED and YELLOW states\n            # See https://docs.openc3.com/docs/configuration/telemetry#state\n            case "RED":\n                pass\n            case "YELLOW":\n                pass\n'})}),"\n",(0,n.jsxs)(s.p,{children:["There are a lot of comments to help you know what to do. The only thing you need to modify is the ",(0,n.jsx)(s.code,{children:"call"})," method."]}),"\n",(0,n.jsx)(s.h3,{id:"call",children:"call"}),"\n",(0,n.jsxs)(s.p,{children:["The call method is where the limits response logic is implemented. As an example, suppose we want to send the ",(0,n.jsx)(s.code,{children:"INST ABORT"})," command every time we enter a RED_HIGH or RED_LOW state. The final result with comments removed looks like the following:"]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-python",children:'from openc3.packets.limits_response import LimitsResponse\nfrom openc3.api import *\nclass AbortLimitsResponse(LimitsResponse):\n    def call(self, packet, item, old_limits_state):\n        match item.limits.state:\n            case "RED_HIGH" | "RED_LOW":\n                cmd("INST ABORT")\n'})}),"\n",(0,n.jsx)(s.h3,{id:"apply-conversion",children:"Apply Conversion"}),"\n",(0,n.jsxs)(s.p,{children:["Now that we have implemented the limits response logic we need to apply it to a telemetry item by adding the line ",(0,n.jsx)(s.code,{children:"LIMITS_RESPONSE abort_limits_response.py"})," in the ",(0,n.jsx)(s.a,{href:"/docs/configuration/telemetry",children:"telemetry"})," definition file. This could look something like this:"]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-bash",children:'TELEMETRY GSE DATA BIG_ENDIAN "Data packet"\n  ... # Header items\n  APPEND_ITEM VALUE 16 UINT "limits response item"\n    LIMITS DEFAULT 1 ENABLED -90 -80 80 90\n    LIMITS_RESPONSE abort_limits_response.py\n'})}),"\n",(0,n.jsxs)(s.p,{children:["The definition combined with the ",(0,n.jsx)(s.code,{children:"AbortLimitsResponse"})," means that each time the ",(0,n.jsx)(s.code,{children:"GSE DATA VALUE"})," item goes below -90 or above 90 the ",(0,n.jsx)(s.code,{children:"INST ABORT"})," command will be sent."]})]})}function d(e={}){let{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(m,{...e})}):m(e)}},677:function(e,s,t){t.d(s,{R:()=>a,x:()=>r});var i=t(6363);let n={},o=i.createContext(n);function a(e){let s=i.useContext(o);return i.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function r(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),i.createElement(o.Provider,{value:s},e.children)}}}]);

data/tools/staticdocs/assets/js/runtime~main.0b4f5e9a.js

@@ -1 +0,0 @@
-(()=>{"use strict";var e,b,d,c,a,f,t,r={},o={};function n(e){var b=o[e];if(void 0!==b)return b.exports;var d=o[e]={exports:{}};return r[e].call(d.exports,d,d.exports,n),d.exports}n.m=r,n.n=e=>{var b=e&&e.__esModule?()=>e.default:()=>e;return n.d(b,{a:b}),b},b=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,n.t=function(d,c){if(1&c&&(d=this(d)),8&c||"object"==typeof d&&d&&(4&c&&d.__esModule||16&c&&"function"==typeof d.then))return d;var a=Object.create(null);n.r(a);var f={};e=e||[null,b({}),b([]),b(b)];for(var t=2&c&&d;"object"==typeof t&&!~e.indexOf(t);t=b(t))Object.getOwnPropertyNames(t).forEach(e=>{f[e]=()=>d[e]});return f.default=()=>d,n.d(a,f),a},n.d=(e,b)=>{for(var d in b)n.o(b,d)&&!n.o(e,d)&&Object.defineProperty(e,d,{enumerable:!0,get:b[d]})},n.f={},n.e=e=>Promise.all(Object.keys(n.f).reduce((b,d)=>(n.f[d](e,b),b),[])),n.u=e=>"assets/js/"+(({1027:"a9987364",1144:"d59d8a14",1448:"75897369",1451:"43652efd",1548:"cf1c01b8",1563:"1e02e6a3",1568:"d66bf9c0",1625:"5fe211ef",1713:"630e5448",1873:"cb8c3f08",1885:"75e64983",2009:"26b8abb2",2030:"b6d70f94",2053:"8b939c74",2102:"13196248",2174:"9424f0b3",2221:"b38a6d74",2452:"5e3ed378",2474:"db8fa1d0",2520:"d57a4b5d",2553:"59ed27a4",257:"1c0a0c05",282:"6b210247",292:"e501b0d1",2991:"62df909c",3051:"22b3ac48",3320:"103cc3be",3389:"a677c089",3430:"058ffc22",3513:"ce89ef36",3670:"fd886806",3808:"6b65133b",3852:"6831b732",3956:"f75a5f33",4189:"5b233ba7",4242:"d5d77c37",4431:"c5388ca4",4553:"54d0d530",4573:"d8ca4191",5013:"964eb012",5196:"cd879be4",5300:"dc5f7beb",5471:"9d6e81d0",5474:"411898ad",5561:"d24bf9b6",5746:"bd0034eb",594:"0ff569c9",5962:"078dbab0",6037:"53ca7c5b",6090:"c24eae19",6112:"b4596165",6175:"c2598f55",6234:"8f7843ee",6310:"aa6b6c1b",6395:"dfbae5fd",640:"a9b2dc27",6443:"d1b923aa",646:"dbe31111",6526:"99581c43",6556:"2c15ad40",6558:"d9b92eba",7343:"13c1b4e4",7397:"35398c5c",7451:"5bc719f6",7513:"7f5b2696",7564:"10209fc9",7785:"42170351",7804:"0f5d161c",7830:"97535711",8024:"696b4199",8104:"b9f60ba6",8445:"89e76475",8461:"f15615f1",8539:"40365d27",8830:"2bb7bf90",8920:"b062d239",9065:"2047b354",9074:"d1bfc316",908:"867640d5",9098:"6f92e431",9165:"019369f3",9445:"72c6d8a8",9512:"3dd7ef3b",9621:"5c6ce5ec",9650:"0686a885",9958:"9fb6059a"})[e]||e)+"."+({1027:"e29e8a93",1144:"79f4b29e",1448:"f13aa17b",1451:"ec6bb7e9",1548:"7d5b6d66",1563:"da7b7250",1568:"ca34a583",1625:"9d68057c",1713:"8195b015",1873:"28d962a4",1885:"338d2338",2009:"858cb22d",2030:"5e40680e",2053:"0ebaed2a",2102:"e93bfd65",2174:"4b6f004e",2221:"bb58fcec",2452:"821e5ed4",2474:"39b9fdb6",2520:"e9712631",2553:"695b2435",257:"427f2699",282:"d400f853",292:"c00adfa4",2991:"1abd26b3",3051:"1932e5a5",3320:"1a538098",3326:"2db66e1b",3389:"758701f0",3402:"80344ef5",3430:"4be515f5",3513:"73fcb368",3670:"fb8a587e",3808:"3550bdf0",3852:"dc5bae56",3956:"f16b6dd5",4071:"821f3b2b",4189:"b0d1a8b1",4242:"e29ff552",4431:"0ddcb653",4553:"2f7aa091",4573:"599a241b",5013:"c7f626c5",5072:"9a0a2752",5196:"782edb7f",5300:"c703e464",5471:"879c9e9e",5474:"8ed3452c",5525:"dd1645b0",5561:"bb93853a",5746:"9f460215",594:"27128023",5962:"f2cbcc66",6037:"3ae5bb0f",6090:"2ef0c706",6112:"9e7f0be7",6175:"7a2138ca",6234:"e33ef7db",6246:"60dfff30",6310:"b566ee29",6395:"011fc630",640:"b7e66efd",6443:"c012712f",646:"4e811739",6526:"2bd0766d",6556:"1b2d4730",6558:"44fde84d",7343:"9735bb59",7397:"8a74eece",7451:"c731b998",7513:"e1f3d862",7564:"669ef887",7785:"7ff72adc",7804:"978b9fee",7830:"a6342866",8024:"d197d085",8104:"63638354",8445:"a301b5e3",8461:"8591b830",8539:"f6769d57",8830:"78594fbb",8920:"2cebb42b",9065:"c86efa5f",9074:"13a64896",908:"555ba5ca",9098:"0bc45585",9165:"64763f3d",9445:"1bbde831",9512:"ceb26a04",9621:"211ced47",9623:"44668503",9650:"3d58085e",9958:"ce4de002"})[e]+".js",n.miniCssF=e=>""+e+".css",n.g=(()=>{if("object"==typeof globalThis)return globalThis;try{return this||Function("return this")()}catch(e){if("object"==typeof window)return window}})(),n.o=(e,b)=>Object.prototype.hasOwnProperty.call(e,b),d={},n.l=function(e,b,c,a){if(d[e])return void d[e].push(b);if(void 0!==c)for(var f,t,r=document.getElementsByTagName("script"),o=0;o<r.length;o++){var i=r[o];if(i.getAttribute("src")==e||i.getAttribute("data-webpack")=="docs-openc3-com:"+c){f=i;break}}f||(t=!0,(f=document.createElement("script")).charset="utf-8",f.timeout=120,n.nc&&f.setAttribute("nonce",n.nc),f.setAttribute("data-webpack","docs-openc3-com:"+c),f.src=e),d[e]=[b];var u=function(b,c){f.onerror=f.onload=null,clearTimeout(s);var a=d[e];if(delete d[e],f.parentNode&&f.parentNode.removeChild(f),a&&a.forEach(function(e){return e(c)}),b)return b(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=u.bind(null,f.onerror),f.onload=u.bind(null,f.onload),t&&document.head.appendChild(f)},n.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},c=[],n.O=(e,b,d,a)=>{if(b){a=a||0;for(var f=c.length;f>0&&c[f-1][2]>a;f--)c[f]=c[f-1];c[f]=[b,d,a];return}for(var t=1/0,f=0;f<c.length;f++){for(var b=c[f][0],d=c[f][1],a=c[f][2],r=!0,o=0;o<b.length;o++)(!1&a||t>=a)&&Object.keys(n.O).every(e=>n.O[e](b[o]))?b.splice(o--,1):(r=!1,a<t&&(t=a));if(r){c.splice(f--,1);var i=d();void 0!==i&&(e=i)}}return e},n.p="/tools/staticdocs/",n.rv=()=>"1.5.8",n.gca=function(e){return e=({0xc95bd8:"2102",0x28377ef:"7785",0x4861a19:"1448",0x5d046df:"7830","1c0a0c05":"257","6b210247":"282",e501b0d1:"292","0ff569c9":"594",a9b2dc27:"640",dbe31111:"646","867640d5":"908",a9987364:"1027",d59d8a14:"1144","43652efd":"1451",cf1c01b8:"1548","1e02e6a3":"1563",d66bf9c0:"1568","5fe211ef":"1625","630e5448":"1713",cb8c3f08:"1873","75e64983":"1885","26b8abb2":"2009",b6d70f94:"2030","8b939c74":"2053","9424f0b3":"2174",b38a6d74:"2221","5e3ed378":"2452",db8fa1d0:"2474",d57a4b5d:"2520","59ed27a4":"2553","62df909c":"2991","22b3ac48":"3051","103cc3be":"3320",a677c089:"3389","058ffc22":"3430",ce89ef36:"3513",fd886806:"3670","6b65133b":"3808","6831b732":"3852",f75a5f33:"3956","5b233ba7":"4189",d5d77c37:"4242",c5388ca4:"4431","54d0d530":"4553",d8ca4191:"4573","964eb012":"5013",cd879be4:"5196",dc5f7beb:"5300","9d6e81d0":"5471","411898ad":"5474",d24bf9b6:"5561",bd0034eb:"5746","078dbab0":"5962","53ca7c5b":"6037",c24eae19:"6090",b4596165:"6112",c2598f55:"6175","8f7843ee":"6234",aa6b6c1b:"6310",dfbae5fd:"6395",d1b923aa:"6443","99581c43":"6526","2c15ad40":"6556",d9b92eba:"6558","13c1b4e4":"7343","35398c5c":"7397","5bc719f6":"7451","7f5b2696":"7513","10209fc9":"7564","0f5d161c":"7804","696b4199":"8024",b9f60ba6:"8104","89e76475":"8445",f15615f1:"8461","40365d27":"8539","2bb7bf90":"8830",b062d239:"8920","2047b354":"9065",d1bfc316:"9074","6f92e431":"9098","019369f3":"9165","72c6d8a8":"9445","3dd7ef3b":"9512","5c6ce5ec":"9621","0686a885":"9650","9fb6059a":"9958"})[e]||e,n.p+n.u(e)},a={4014:0,9783:0},n.f.j=function(e,b){var d=n.o(a,e)?a[e]:void 0;if(0!==d)if(d)b.push(d[2]);else if(/^(4014|9783)$/.test(e))a[e]=0;else{var c=new Promise((b,c)=>d=a[e]=[b,c]);b.push(d[2]=c);var f=n.p+n.u(e),t=Error();n.l(f,function(b){if(n.o(a,e)&&(0!==(d=a[e])&&(a[e]=void 0),d)){var c=b&&("load"===b.type?"missing":b.type),f=b&&b.target&&b.target.src;t.message="Loading chunk "+e+" failed.\n("+c+": "+f+")",t.name="ChunkLoadError",t.type=c,t.request=f,d[1](t)}},"chunk-"+e,e)}},n.O.j=e=>0===a[e],f=(e,b)=>{var d,c,f=b[0],t=b[1],r=b[2],o=0;if(f.some(e=>0!==a[e])){for(d in t)n.o(t,d)&&(n.m[d]=t[d]);if(r)var i=r(n)}for(e&&e(b);o<f.length;o++)c=f[o],n.o(a,c)&&a[c]&&a[c][0](),a[c]=0;return n.O(i)},(t=self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).forEach(f.bind(null,0)),t.push=f.bind(null,t.push.bind(t)),n.ruid="bundler=rspack@1.5.8"})();