Module:digiorbcomm
From Digi Developer
Contents |
digiorbcomm.py
This module was designed in conjunction with the Digi ConnectPort X5 Fleet, the first Digi Python-enabled product to offer ORBCOMM satellite network connectivity. The module is designed to allow scripts to manipulate messages from the ORBCOMM serial interface API at a logical level, with the embedded operating system providing support for the encoding/decoding of messages on the line, and servicing the link layer of the ORBCOMM serial interface protocol.
Knowledge of the ORBCOMM serial interface API is required to take full advantage of this module.
Module help
Help on built-in module digiorbcomm:
NAME
digiorbcomm
FILE
(built-in)
DESCRIPTION
Provides an interface to allow Python scripts to interact with an ORBCOMM satellite modem module in the system.
CLASSES
__builtin__.object
CommCmd
ConfigCmd
PosDeterCmd
PosStatus
ReceiveCallback
SCOrigDefMsg
SCOrigDefRep
SCOrigGlobGram
SCOrigMsg
SCOrigPosRep
SCOrigRep
SCTermGlobGram
SCTermMsg
SCTermUserCmd
SatOrbElem
SatPlaneOrbElem
SatStateVec
Status
SysAnnounce
SysResp
class CommCmd(__builtin__.object)
| ORBCOMM Serial Interface Communications Command
|
| Methods defined here:
|
| done(...)
| done() -> None
|
| submit(...)
| submit() -> None
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __new__ = <built-in method __new__ of type object>
| T.__new__(S, ...) -> a new object with type S, a subtype of T
|
| gwy_id = <attribute 'gwy_id' of 'digiorbcomm.CommCmd' objects>
| destination ORBCOMM Gateway
|
| msg_status = <attribute 'msg_status' of 'digiorbcomm.CommCmd' objects>
| ORBCOMM message status
|
| msg_type = <attribute 'msg_type' of 'digiorbcomm.CommCmd' objects>
| ORBCOMM Serial Interface message type
|
| type_code = <attribute 'type_code' of 'digiorbcomm.CommCmd' objects>
| type of action requested
|
| value = <attribute 'value' of 'digiorbcomm.CommCmd' objects>
| generic value pertinent to type of action requested
class ConfigCmd(__builtin__.object)
| ORBCOMM Serial Interface Configuration Command
|
| Methods defined here:
|
| done(...)
| done() -> None
|
| submit(...)
| submit() -> None
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __new__ = <built-in method __new__ of type object>
| T.__new__(S, ...) -> a new object with type S, a subtype of T
|
| def_ack_level = <attribute 'def_ack_level' of 'digiorbcomm.ConfigCmd' ...
| default acknowledgement level
|
| def_msg_body_type = <attribute 'def_msg_body_type' of 'digiorbcomm.Con...
| default body type for Messages
|
| def_msg_or_ind = <attribute 'def_msg_or_ind' of 'digiorbcomm.ConfigCmd...
| default OR indicator for Messages
|
| def_polled = <attribute 'def_polled' of 'digiorbcomm.ConfigCmd' object...
| polled by Gateway or initiated by SC
|
| def_priority = <attribute 'def_priority' of 'digiorbcomm.ConfigCmd' ob...
| default priority level
|
| def_rep_or_ind = <attribute 'def_rep_or_ind' of 'digiorbcomm.ConfigCmd...
| default OR indicator for Reports
|
| def_serv_type = <attribute 'def_serv_type' of 'digiorbcomm.ConfigCmd' ...
| default service type for Reports
|
| desired_gwy_id = <attribute 'desired_gwy_id' of 'digiorbcomm.ConfigCmd...
| acquire Satellite having this ORBCOMM Gateway
|
| gwy_search_mode = <attribute 'gwy_search_mode' of 'digiorbcomm.ConfigC...
| method for searching for downlinks
|
| msg_status = <attribute 'msg_status' of 'digiorbcomm.ConfigCmd' object...
| ORBCOMM message status
|
| msg_type = <attribute 'msg_type' of 'digiorbcomm.ConfigCmd' objects>
| ORBCOMM Serial Interface message type
|
| pin_code = <attribute 'pin_code' of 'digiorbcomm.ConfigCmd' objects>
| personal identification number
class PosDeterCmd(__builtin__.object)
| ORBCOMM Serial Interface Position Determination Command
|
| Methods defined here:
|
| done(...)
| done() -> None
|
| submit(...)
| submit() -> None
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __new__ = <built-in method __new__ of type object>
| T.__new__(S, ...) -> a new object with type S, a subtype of T
|
| msg_status = <attribute 'msg_status' of 'digiorbcomm.PosDeterCmd' obje...
| ORBCOMM message status
|
| msg_type = <attribute 'msg_type' of 'digiorbcomm.PosDeterCmd' objects>
| ORBCOMM Serial Interface message type
|
| type_code = <attribute 'type_code' of 'digiorbcomm.PosDeterCmd' object...
| type of action requested
class PosStatus(__builtin__.object)
| ORBCOMM Serial Interface Position Status Message
|
| Methods defined here:
|
| done(...)
| done() -> None
|
| submit(...)
| submit() -> None
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __new__ = <built-in method __new__ of type object>
| T.__new__(S, ...) -> a new object with type S, a subtype of T
|
| lat_code = <attribute 'lat_code' of 'digiorbcomm.PosStatus' objects>
| coded geodetic latitude
|
| lon_code = <attribute 'lon_code' of 'digiorbcomm.PosStatus' objects>
| coded geodetic longitude
|
| msg_status = <attribute 'msg_status' of 'digiorbcomm.PosStatus' object...
| ORBCOMM message status
|
| msg_type = <attribute 'msg_type' of 'digiorbcomm.PosStatus' objects>
| ORBCOMM Serial Interface message type
|
| pos_calc_active = <attribute 'pos_calc_active' of 'digiorbcomm.PosStat...
| state of position determination process
class ReceiveCallback(__builtin__.object)
| Register a callback for ORBCOMM message reception.
|
| digiorbcomm.ReceiveCallback(cb, arg) -> handle
|
| Returns a handle to be used for deregistration later. The
| callback will be handled as long as the callback handle
| exists. If the handle goes out of scope or is deallocated,
| the callback will be unregistered.
|
| The "arg" parameter is arbitrary, and will be stored to be
| passed to the callback function with each message.
|
| Callback functions should be of the form:
| cb(msg, arg) -> None
|
| CB Param:
| msg: An ORBCOMM message class instance
| arg: Callback argument supplied during registration
|
| Remember, call back functions will be executed in another
| thread. Shared data will need to be protected from race
| conditions due to concurrent access.
|
| Data and other attributes defined here:
|
| __new__ = <built-in method __new__ of type object>
| T.__new__(S, ...) -> a new object with type S, a subtype of T
class SCOrigDefMsg(__builtin__.object)
| ORBCOMM Serial Interface SC-Originated Default Message
|
| Methods defined here:
|
| done(...)
| done() -> None
|
| submit(...)
| submit() -> None
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __new__ = <built-in method __new__ of type object>
| T.__new__(S, ...) -> a new object with type S, a subtype of T
|
| mha_ref_num = <attribute 'mha_ref_num' of 'digiorbcomm.SCOrigDefMsg' o...
| DTE assigned, used to identify among multiple messages
|
| msg_body = <attribute 'msg_body' of 'digiorbcomm.SCOrigDefMsg' objects...
| message body
|
| msg_status = <attribute 'msg_status' of 'digiorbcomm.SCOrigDefMsg' obj...
| ORBCOMM message status
|
| msg_type = <attribute 'msg_type' of 'digiorbcomm.SCOrigDefMsg' objects...
| ORBCOMM Serial Interface message type
class SCOrigDefRep(__builtin__.object)
| ORBCOMM Serial Interface SC-Originated Default Report
|
| Methods defined here:
|
| done(...)
| done() -> None
|
| submit(...)
| submit() -> None
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __new__ = <built-in method __new__ of type object>
| T.__new__(S, ...) -> a new object with type S, a subtype of T
|
| mha_ref_num = <attribute 'mha_ref_num' of 'digiorbcomm.SCOrigDefRep' o...
| DTE assigned, used to identify among multiple messages
|
| msg_status = <attribute 'msg_status' of 'digiorbcomm.SCOrigDefRep' obj...
| ORBCOMM message status
|
| msg_type = <attribute 'msg_type' of 'digiorbcomm.SCOrigDefRep' objects...
| ORBCOMM Serial Interface message type
|
| user_data = <attribute 'user_data' of 'digiorbcomm.SCOrigDefRep' objec...
| up to six bytes of user data
class SCOrigGlobGram(__builtin__.object)
| ORBCOMM Serial Interface SC-Originated Globalgram
|
| Methods defined here:
|
| done(...)
| done() -> None
|
| submit(...)
| submit() -> None
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __new__ = <built-in method __new__ of type object>
| T.__new__(S, ...) -> a new object with type S, a subtype of T
|
| gwy_id = <attribute 'gwy_id' of 'digiorbcomm.SCOrigGlobGram' objects>
| destination ORBCOMM Gateway ID
|
| mha_ref_num = <attribute 'mha_ref_num' of 'digiorbcomm.SCOrigGlobGram'...
| DTE assigned, used to identify among multiple messages
|
| msg_status = <attribute 'msg_status' of 'digiorbcomm.SCOrigGlobGram' o...
| ORBCOMM message status
|
| msg_type = <attribute 'msg_type' of 'digiorbcomm.SCOrigGlobGram' objec...
| ORBCOMM Serial Interface message type
|
| or_ind = <attribute 'or_ind' of 'digiorbcomm.SCOrigGlobGram' objects>
| originator/recipient indicator
|
| user_data = <attribute 'user_data' of 'digiorbcomm.SCOrigGlobGram' obj...
| up to 229 bytes of user data
class SCOrigMsg(__builtin__.object)
| ORBCOMM Serial Interface SC-Originated Message
|
| Methods defined here:
|
| done(...)
| done() -> None
|
| submit(...)
| submit() -> None
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __new__ = <built-in method __new__ of type object>
| T.__new__(S, ...) -> a new object with type S, a subtype of T
|
| ack_level = <attribute 'ack_level' of 'digiorbcomm.SCOrigMsg' objects>
| message acknowledgement level
|
| cc_rcpnt_addr = <attribute 'cc_rcpnt_addr' of 'digiorbcomm.SCOrigMsg' ...
| Sequence of strings or integers, representing copied recipients of the message
|
| gwy_id = <attribute 'gwy_id' of 'digiorbcomm.SCOrigMsg' objects>
| destination ORBCOMM Gateway ID
|
| mha_ref_num = <attribute 'mha_ref_num' of 'digiorbcomm.SCOrigMsg' obje...
| DTE assigned, used to identify among multiple messages
|
| msg_body = <attribute 'msg_body' of 'digiorbcomm.SCOrigMsg' objects>
| message body
|
| msg_body_type = <attribute 'msg_body_type' of 'digiorbcomm.SCOrigMsg' ...
| message body type
|
| msg_status = <attribute 'msg_status' of 'digiorbcomm.SCOrigMsg' object...
| ORBCOMM message status
|
| msg_type = <attribute 'msg_type' of 'digiorbcomm.SCOrigMsg' objects>
| ORBCOMM Serial Interface message type
|
| polled = <attribute 'polled' of 'digiorbcomm.SCOrigMsg' objects>
| polled by Gateway or initiated by SC
|
| priority = <attribute 'priority' of 'digiorbcomm.SCOrigMsg' objects>
| message priority level
|
| rcpnt_addr = <attribute 'rcpnt_addr' of 'digiorbcomm.SCOrigMsg' object...
| Sequence of strings or integers, representing direct recipients of the message
|
| subj = <attribute 'subj' of 'digiorbcomm.SCOrigMsg' objects>
| message subject, or None to indicate no subject
class SCOrigPosRep(__builtin__.object)
| ORBCOMM Serial Interface SC-Originated Position Report
|
| Methods defined here:
|
| done(...)
| done() -> None
|
| submit(...)
| submit() -> None
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __new__ = <built-in method __new__ of type object>
| T.__new__(S, ...) -> a new object with type S, a subtype of T
|
| lat_code = <attribute 'lat_code' of 'digiorbcomm.SCOrigPosRep' objects...
| coded geodetic latitude
|
| lon_code = <attribute 'lon_code' of 'digiorbcomm.SCOrigPosRep' objects...
| coded geodetic longitude
|
| mha_ref_num = <attribute 'mha_ref_num' of 'digiorbcomm.SCOrigPosRep' o...
| DTE assigned, used to identify among multiple messages
|
| msg_status = <attribute 'msg_status' of 'digiorbcomm.SCOrigPosRep' obj...
| ORBCOMM message status
|
| msg_type = <attribute 'msg_type' of 'digiorbcomm.SCOrigPosRep' objects...
| ORBCOMM Serial Interface message type
class SCOrigRep(__builtin__.object)
| ORBCOMM Serial Interface SC-Originated Report
|
| Methods defined here:
|
| done(...)
| done() -> None
|
| submit(...)
| submit() -> None
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __new__ = <built-in method __new__ of type object>
| T.__new__(S, ...) -> a new object with type S, a subtype of T
|
| gwy_id = <attribute 'gwy_id' of 'digiorbcomm.SCOrigRep' objects>
| destination ORBCOMM Gateway ID
|
| mha_ref_num = <attribute 'mha_ref_num' of 'digiorbcomm.SCOrigRep' obje...
| DTE assigned, used to identify among multiple messages
|
| msg_status = <attribute 'msg_status' of 'digiorbcomm.SCOrigRep' object...
| ORBCOMM message status
|
| msg_type = <attribute 'msg_type' of 'digiorbcomm.SCOrigRep' objects>
| ORBCOMM Serial Interface message type
|
| or_ind = <attribute 'or_ind' of 'digiorbcomm.SCOrigRep' objects>
| originator/recipient indicator, only values 0-3
|
| polled = <attribute 'polled' of 'digiorbcomm.SCOrigRep' objects>
| polled by Gateway or initiated by SC
|
| serv_type = <attribute 'serv_type' of 'digiorbcomm.SCOrigRep' objects>
| service type
|
| user_data = <attribute 'user_data' of 'digiorbcomm.SCOrigRep' objects>
| up to six bytes of user data
class SCTermGlobGram(__builtin__.object)
| ORBCOMM Serial Interface SC-Terminated Globalgram
|
| Methods defined here:
|
| done(...)
| done() -> None
|
| submit(...)
| submit() -> None
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __new__ = <built-in method __new__ of type object>
| T.__new__(S, ...) -> a new object with type S, a subtype of T
|
| gwy_dgram_ref_num = <attribute 'gwy_dgram_ref_num' of 'digiorbcomm.SCT...
| used to identify among multiple Globalgrams
|
| gwy_id = <attribute 'gwy_id' of 'digiorbcomm.SCTermGlobGram' objects>
| originating ORBCOMM Gateway ID
|
| msg_status = <attribute 'msg_status' of 'digiorbcomm.SCTermGlobGram' o...
| ORBCOMM message status
|
| msg_type = <attribute 'msg_type' of 'digiorbcomm.SCTermGlobGram' objec...
| ORBCOMM Serial Interface message type
|
| or_ind = <attribute 'or_ind' of 'digiorbcomm.SCTermGlobGram' objects>
| originator/recipient indicator
|
| user_data = <attribute 'user_data' of 'digiorbcomm.SCTermGlobGram' obj...
| user data
class SCTermMsg(__builtin__.object)
| ORBCOMM Serial Interface SC-Terminated Message
|
| Methods defined here:
|
| done(...)
| done() -> None
|
| submit(...)
| submit() -> None
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __new__ = <built-in method __new__ of type object>
| T.__new__(S, ...) -> a new object with type S, a subtype of T
|
| gwy_id = <attribute 'gwy_id' of 'digiorbcomm.SCTermMsg' objects>
| originating ORBCOMM Gateway ID
|
| msg_body = <attribute 'msg_body' of 'digiorbcomm.SCTermMsg' objects>
| message body string
|
| msg_body_type = <attribute 'msg_body_type' of 'digiorbcomm.SCTermMsg' ...
| message body type
|
| msg_status = <attribute 'msg_status' of 'digiorbcomm.SCTermMsg' object...
| ORBCOMM message status
|
| msg_type = <attribute 'msg_type' of 'digiorbcomm.SCTermMsg' objects>
| ORBCOMM Serial Interface message type
|
| or_addr = <attribute 'or_addr' of 'digiorbcomm.SCTermMsg' objects>
| originator indicator or address, or None
|
| rcpnt_addr = <attribute 'rcpnt_addr' of 'digiorbcomm.SCTermMsg' object...
| list of copied recipients, or None
|
| subj = <attribute 'subj' of 'digiorbcomm.SCTermMsg' objects>
| message subject string, or None
class SCTermUserCmd(__builtin__.object)
| ORBCOMM Serial Interface SC-Terminated User Command
|
| Methods defined here:
|
| done(...)
| done() -> None
|
| submit(...)
| submit() -> None
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __new__ = <built-in method __new__ of type object>
| T.__new__(S, ...) -> a new object with type S, a subtype of T
|
| gwy_id = <attribute 'gwy_id' of 'digiorbcomm.SCTermUserCmd' objects>
| originating ORBCOMM Gateway ID
|
| msg_status = <attribute 'msg_status' of 'digiorbcomm.SCTermUserCmd' ob...
| ORBCOMM message status
|
| msg_type = <attribute 'msg_type' of 'digiorbcomm.SCTermUserCmd' object...
| ORBCOMM Serial Interface message type
|
| user_data = <attribute 'user_data' of 'digiorbcomm.SCTermUserCmd' obje...
| user data
class SatOrbElem(__builtin__.object)
| ORBCOMM Serial Interface Satellite Orbital Elements
|
| Methods defined here:
|
| done(...)
| done() -> None
|
| submit(...)
| submit() -> None
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __new__ = <built-in method __new__ of type object>
| T.__new__(S, ...) -> a new object with type S, a subtype of T
|
| mean_anom = <attribute 'mean_anom' of 'digiorbcomm.SatOrbElem' objects...
| Mean Anomaly for this satellite
|
| mean_motion = <attribute 'mean_motion' of 'digiorbcomm.SatOrbElem' obj...
| ECEF position coordinates, 'y' component
|
| msg_status = <attribute 'msg_status' of 'digiorbcomm.SatOrbElem' objec...
| ORBCOMM message status
|
| msg_type = <attribute 'msg_type' of 'digiorbcomm.SatOrbElem' objects>
| ORBCOMM Serial Interface message type
|
| plane_id = <attribute 'plane_id' of 'digiorbcomm.SatOrbElem' objects>
| Identifies the satellite plane
|
| sat_id = <attribute 'sat_id' of 'digiorbcomm.SatOrbElem' objects>
| ID of satellite to which this data pertains
class SatPlaneOrbElem(__builtin__.object)
| ORBCOMM Serial Interface Satellite Plane Orbital Elements
|
| Methods defined here:
|
| done(...)
| done() -> None
|
| submit(...)
| submit() -> None
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __new__ = <built-in method __new__ of type object>
| T.__new__(S, ...) -> a new object with type S, a subtype of T
|
| decay = <attribute 'decay' of 'digiorbcomm.SatPlaneOrbElem' objects>
| decay in orbit
|
| eccent = <attribute 'eccent' of 'digiorbcomm.SatPlaneOrbElem' objects>
| eccentricity of orbit
|
| epoch = <attribute 'epoch' of 'digiorbcomm.SatPlaneOrbElem' objects>
| epoch time (milliseconds since 1/1/93)
|
| inclin = <attribute 'inclin' of 'digiorbcomm.SatPlaneOrbElem' objects>
| inclination
|
| msg_status = <attribute 'msg_status' of 'digiorbcomm.SatPlaneOrbElem' ...
| ORBCOMM message status
|
| msg_type = <attribute 'msg_type' of 'digiorbcomm.SatPlaneOrbElem' obje...
| ORBCOMM Serial Interface message type
|
| orbit_num = <attribute 'orbit_num' of 'digiorbcomm.SatPlaneOrbElem' ob...
| number of complete orbits since epoch
|
| perigee = <attribute 'perigee' of 'digiorbcomm.SatPlaneOrbElem' object...
| argument of perigee
|
| plane_id = <attribute 'plane_id' of 'digiorbcomm.SatPlaneOrbElem' obje...
| Identifies the satellite plane
|
| raan = <attribute 'raan' of 'digiorbcomm.SatPlaneOrbElem' objects>
| right ascension of ascending node
|
| sat_quan = <attribute 'sat_quan' of 'digiorbcomm.SatPlaneOrbElem' obje...
| total number of satellites in the system
class SatStateVec(__builtin__.object)
| ORBCOMM Serial Interface Satellite State Vector
|
| Methods defined here:
|
| done(...)
| done() -> None
|
| submit(...)
| submit() -> None
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __new__ = <built-in method __new__ of type object>
| T.__new__(S, ...) -> a new object with type S, a subtype of T
|
| msg_status = <attribute 'msg_status' of 'digiorbcomm.SatStateVec' obje...
| ORBCOMM message status
|
| msg_type = <attribute 'msg_type' of 'digiorbcomm.SatStateVec' objects>
| ORBCOMM Serial Interface message type
|
| sat_id = <attribute 'sat_id' of 'digiorbcomm.SatStateVec' objects>
| ID of satellite to which this data pertains
|
| x = <attribute 'x' of 'digiorbcomm.SatStateVec' objects>
| ECEF position coordinates, 'x' component
|
| x_dot = <attribute 'x_dot' of 'digiorbcomm.SatStateVec' objects>
| ECEF velocity, 'x' component
|
| y = <attribute 'y' of 'digiorbcomm.SatStateVec' objects>
| ECEF position coordinates, 'y' component
|
| y_dot = <attribute 'y_dot' of 'digiorbcomm.SatStateVec' objects>
| ECEF velocity, 'y' component
|
| z = <attribute 'z' of 'digiorbcomm.SatStateVec' objects>
| ECEF position coordinates, 'z' component
|
| z_dot = <attribute 'z_dot' of 'digiorbcomm.SatStateVec' objects>
| ECEF velocity, 'z' component
class Status(__builtin__.object)
| ORBCOMM Serial Interface Status Message
|
| Methods defined here:
|
| done(...)
| done() -> None
|
| submit(...)
| submit() -> None
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __new__ = <built-in method __new__ of type object>
| T.__new__(S, ...) -> a new object with type S, a subtype of T
|
| active_mha_msg_ref = <attribute 'active_mha_msg_ref' of 'digiorbcomm.S...
| MHA # of message being transferred (0xFF = no msg)
|
| check_errs = <attribute 'check_errs' of 'digiorbcomm.Status' objects>
| number of downlink packets with bad checksum since last status packet
|
| gwy_list = <attribute 'gwy_list' of 'digiorbcomm.Status' objects>
| list of tuples of ORBCOMM Gateway's and their minimum acceptable message priority
|
| msg_status = <attribute 'msg_status' of 'digiorbcomm.Status' objects>
| ORBCOMM message status
|
| msg_type = <attribute 'msg_type' of 'digiorbcomm.Status' objects>
| ORBCOMM Serial Interface message type
|
| queued_ib_msgs = <attribute 'queued_ib_msgs' of 'digiorbcomm.Status' o...
| number of SC-Originated messages in SC memory
|
| queued_ob_msgs = <attribute 'queued_ob_msgs' of 'digiorbcomm.Status' o...
| number of SC-Terminated messages in SC memory
|
| sat_in_view = <attribute 'sat_in_view' of 'digiorbcomm.Status' objects...
| current satellite number, 0 if no satellite in view
|
| sc_diag_code = <attribute 'sc_diag_code' of 'digiorbcomm.Status' objec...
| diagnostic code from self test
|
| sc_state = <attribute 'sc_state' of 'digiorbcomm.Status' objects>
| state of SC, message transport processes
|
| stored_sats = <attribute 'stored_sats' of 'digiorbcomm.Status' objects...
| number of stored satellite orbital elements
|
| time = <attribute 'time' of 'digiorbcomm.Status' objects>
| 24 bit integer representing number of seconds since 00:00:00 UTC, resets midnight Sunday
|
| total_sats = <attribute 'total_sats' of 'digiorbcomm.Status' objects>
| total number of satellites in system
|
| week = <attribute 'week' of 'digiorbcomm.Status' objects>
| UTC time week, starting January 6, 1980
class SysAnnounce(__builtin__.object)
| ORBCOMM Serial Interface System Announcement
|
| Methods defined here:
|
| done(...)
| done() -> None
|
| submit(...)
| submit() -> None
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __new__ = <built-in method __new__ of type object>
| T.__new__(S, ...) -> a new object with type S, a subtype of T
|
| announce_code = <attribute 'announce_code' of 'digiorbcomm.SysAnnounce...
| system provided information
|
| dest_or_ind = <attribute 'dest_or_ind' of 'digiorbcomm.SysAnnounce' ob...
| destination OR indicator
|
| gwy_id = <attribute 'gwy_id' of 'digiorbcomm.SysAnnounce' objects>
| originating ORBCOMM Gateway
|
| msg_status = <attribute 'msg_status' of 'digiorbcomm.SysAnnounce' obje...
| ORBCOMM message status
|
| msg_type = <attribute 'msg_type' of 'digiorbcomm.SysAnnounce' objects>
| ORBCOMM Serial Interface message type
class SysResp(__builtin__.object)
| ORBCOMM Serial Interface System Response
|
| Methods defined here:
|
| done(...)
| done() -> None
|
| submit(...)
| submit() -> None
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __new__ = <built-in method __new__ of type object>
| T.__new__(S, ...) -> a new object with type S, a subtype of T
|
| ack_mask = <attribute 'ack_mask' of 'digiorbcomm.SysResp' objects>
| which recipients apply to this ACK
|
| diag_code = <attribute 'diag_code' of 'digiorbcomm.SysResp' objects>
| diagnostic code
|
| gwy_ref_num = <attribute 'gwy_ref_num' of 'digiorbcomm.SysResp' object...
| ORBCOMM Gateway assigned, used for delivery confirmation
|
| mha_ref_num = <attribute 'mha_ref_num' of 'digiorbcomm.SysResp' object...
| DTE assigned, used to uniquely identify messages
|
| msg_status = <attribute 'msg_status' of 'digiorbcomm.SysResp' objects>
| ORBCOMM message status
|
| msg_type = <attribute 'msg_type' of 'digiorbcomm.SysResp' objects>
| ORBCOMM Serial Interface message type
|
| origin = <attribute 'origin' of 'digiorbcomm.SysResp' objects>
| type of originator of this acknowledgment
|
| origin_id = <attribute 'origin_id' of 'digiorbcomm.SysResp' objects>
| ID of originator, either sat_id or gwy_id
|
| status = <attribute 'status' of 'digiorbcomm.SysResp' objects>
| status of message transfer or message enquiry
FUNCTIONS
param_request(...)
param_request(param [, data]) -> result
Execute a request for a parameter "get", or a parameter
"set" if the optional "data" parameter is supplied.
The struct module is recommended for composing the "data"
parameter and parsing the "result" string.
Arguments:
param -- integer parameter number, corresponding to
those found in the ORBCOMM Serial Interface
Specification.
data -- a string to be supplied as the value for a
parameter set operation.
Return Value:
The result is always the responding value string from
the ORBCOMM modem for the requested parameter, or an
exception is thrown.
Availability
Products which support this module
ConnectPort X5 Fleet with optional ORBCOMM satellite modem
