chrome.serial

ब्यौरा

सीरियल पोर्ट से कनेक्ट किए गए किसी डिवाइस से डेटा पढ़ने और उसमें डेटा लिखने के लिए, chrome.serial एपीआई का इस्तेमाल करें.

अनुमतियां

serial

उपलब्धता

सिर्फ़ ChromeOS के लिए

टाइप

ConnectionInfo

प्रॉपर्टी

  • बिटरेट

    number ज़रूरी नहीं

    ConnectionOptions.bitrate देखें. अगर स्टैंडर्ड बिटरेट का इस्तेमाल नहीं किया जा रहा है या डिवाइस से क्वेरी करते समय कोई गड़बड़ी हुई है, तो हो सकता है कि यह फ़ील्ड मौजूद न हो या गलत हो.

  • bufferSize

    संख्या

    ConnectionOptions.bufferSize देखें

  • connectionId

    संख्या

    सीरियल पोर्ट कनेक्शन का आईडी.

  • ctsFlowControl

    बूलियन ज़रूरी नहीं

    ConnectionOptions.ctsFlowControl देखें. अगर डिवाइस से क्वेरी करते समय कोई गड़बड़ी होती है, तो इस फ़ील्ड को छोड़ा जा सकता है.

  • dataBits

    DataBits ज़रूरी नहीं

    ConnectionOptions.dataBits देखें. अगर डिवाइस से क्वेरी करते समय कोई गड़बड़ी होती है, तो इस फ़ील्ड को छोड़ा जा सकता है.

  • नाम

    स्ट्रिंग

    ConnectionOptions.name देखें

  • parityBit

    ParityBit ज़रूरी नहीं

    ConnectionOptions.parityBit देखें. अगर डिवाइस से क्वेरी करते समय कोई गड़बड़ी होती है, तो इस फ़ील्ड को छोड़ा जा सकता है.

  • रोका गया

    बूलियन

    इस फ़्लैग से पता चलता है कि कनेक्शन को onReceive इवेंट ट्रिगर करने से ब्लॉक किया गया है या नहीं.

  • अनवरत

    बूलियन

    ConnectionOptions.persistent देखें

  • receiveTimeout

    संख्या

    ConnectionOptions.receiveTimeout देखें

  • sendTimeout

    संख्या

    ConnectionOptions.sendTimeout देखें

  • stopBits

    StopBits ज़रूरी नहीं

    ConnectionOptions.stopBits देखें. अगर डिवाइस से क्वेरी करते समय कोई गड़बड़ी होती है, तो इस फ़ील्ड को छोड़ा जा सकता है.

ConnectionOptions

प्रॉपर्टी

  • बिटरेट

    number ज़रूरी नहीं

    कनेक्शन खोलने के लिए, अनुरोध किया गया बिटरेट. ज़्यादा से ज़्यादा हार्डवेयर के साथ काम करने के लिए, यह संख्या आम तौर पर उपलब्ध बिटरेट में से किसी एक से मेल खानी चाहिए. जैसे, 110, 300, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200. इस बात की कोई गारंटी नहीं है कि सीरियल पोर्ट से कनेक्ट किया गया डिवाइस, अनुरोध की गई बिटरेट के साथ काम करेगा. भले ही, पोर्ट खुद उस बिटरेट के साथ काम करता हो. डिफ़ॉल्ट रूप से, 9600 को पास किया जाएगा.

  • bufferSize

    number ज़रूरी नहीं

    डेटा पाने के लिए इस्तेमाल किए जाने वाले बफ़र का साइज़. इसकी डिफ़ॉल्ट वैल्यू 4096 होती है.

  • ctsFlowControl

    बूलियन ज़रूरी नहीं

    इस फ़्लैग से पता चलता है कि आरटीएस/सीटीएस हार्डवेयर फ़्लो कंट्रोल को चालू करना है या नहीं. डिफ़ॉल्ट तौर पर, यह 'गलत' पर सेट होती है.

  • dataBits

    DataBits ज़रूरी नहीं

    डिफ़ॉल्ट रूप से, "eight" को पास किया जाएगा.

  • नाम

    string ज़रूरी नहीं

    कनेक्शन से जोड़ने के लिए, ऐप्लिकेशन के हिसाब से तय की गई स्ट्रिंग.

  • parityBit

    ParityBit ज़रूरी नहीं

    डिफ़ॉल्ट रूप से, "no" को पास किया जाएगा.

  • अनवरत

    बूलियन ज़रूरी नहीं

    यह फ़्लैग बताता है कि ऐप्लिकेशन के निलंबित होने पर, कनेक्शन को खुला रखना चाहिए या नहीं (ऐप्लिकेशन लाइफ़साइकल मैनेज करें देखें). इसकी डिफ़ॉल्ट वैल्यू "false" है. ऐप्लिकेशन लोड होने पर, persistent=true के साथ पहले खोले गए किसी भी सीरियल कनेक्शन को getConnections की मदद से फ़ेच किया जा सकता है.

  • receiveTimeout

    number ज़रूरी नहीं

    "टाइम आउट" गड़बड़ी के साथ onReceiveError इवेंट को ट्रिगर करने से पहले, नए डेटा के लिए इंतज़ार करने का ज़्यादा से ज़्यादा समय (मिलीसेकंड में). अगर इसे शून्य पर सेट किया जाता है, तो कनेक्शन के लिए, टाइम आउट की गड़बड़ियां नहीं दिखेंगी. डिफ़ॉल्ट रूप से, इसकी वैल्यू 0 होती है.

  • sendTimeout

    number ज़रूरी नहीं

    "टाइम आउट" गड़बड़ी के साथ कॉलबैक को कॉल करने से पहले, send कार्रवाई के पूरा होने का इंतज़ार करने के लिए ज़्यादा से ज़्यादा समय (मिलीसेकंड में). अगर शून्य है, तो टाइम आउट की गड़बड़ियां ट्रिगर नहीं होंगी. डिफ़ॉल्ट रूप से, इसकी वैल्यू 0 होती है.

  • stopBits

    StopBits ज़रूरी नहीं

    डिफ़ॉल्ट रूप से, "one" को पास किया जाएगा.

DataBits

Enum

"seven"

"eight"

DeviceControlSignals

प्रॉपर्टी

  • cts

    बूलियन

    सीटीएस (क्लियर टू सेंड).

  • dcd

    बूलियन

    डीसीडी (डेटा कैरियर डिटेक्ट) या आरएलएसडी (रिसीव लाइन सिग्नल/डिटेक्ट).

  • dsr

    बूलियन

    डीएसआर (डेटा सेट रेडी).

  • ri

    बूलियन

    आरआई (रिंग इंडिकेटर).

DeviceInfo

प्रॉपर्टी

  • displayName

    string ज़रूरी नहीं

    डिवाइस का ऐसा डिसप्ले नेम जिसे कोई व्यक्ति आसानी से पढ़ सके. हालांकि, ऐसा तब ही होगा, जब होस्ट ड्राइवर से क्वेरी की जा सके.

  • पाथ

    स्ट्रिंग

    डिवाइस का सिस्टम पाथ. इस डिवाइस से कनेक्ट करने के लिए, इसे chrome.serial.connect में path आर्ग्युमेंट के तौर पर पास किया जाना चाहिए.

  • productId

    number ज़रूरी नहीं

    अगर डिवाइस के लिए यूएसबी प्रॉडक्ट आईडी तय किया जा सकता है, तो वह आईडी.

  • vendorId

    number ज़रूरी नहीं

    अगर डिवाइस के लिए पीसीआई या यूएसबी वेंडर आईडी तय किया जा सकता है, तो वह आईडी.

HostControlSignals

प्रॉपर्टी

  • dtr

    बूलियन ज़रूरी नहीं

    डीटीआर (डेटा टर्मिनल रेडी).

  • आरटीएस

    बूलियन ज़रूरी नहीं

    आरटीएस (रिक्वेस्ट टू सेंड).

ParityBit

Enum

"no"

"odd"

"even"

ReceiveError

Enum

"disconnected"
कनेक्शन डिसकनेक्ट हो गया था.

"timeout"
receiveTimeout मिलीसेकंड तक कोई डेटा नहीं मिला.

"device_lost"
ऐसा हो सकता है कि डिवाइस, होस्ट से डिसकनेक्ट हो गया हो.

"break"
डिवाइस को ब्रेक की स्थिति का पता चला.

"frame_error"
डिवाइस को फ़्रेमिंग से जुड़ी गड़बड़ी का पता चला.

"overrun"
कैरेक्टर-बफ़र ओवररन हुआ है. अगला वर्ण मिट गया है.

"buffer_overflow"
इनपुट बफ़र ओवरफ़्लो हुआ है. इनपुट बफ़र में कोई जगह नहीं है या एंड-ऑफ़-फ़ाइल (ईओएफ़) वर्ण के बाद कोई वर्ण मिला है.

"parity_error"
डिवाइस को पैरिटी एरर का पता चला.

"system_error"
सिस्टम में कोई गड़बड़ी हुई है और हो सकता है कि कनेक्शन को वापस न पाया जा सके.

ReceiveErrorInfo

प्रॉपर्टी

  • connectionId

    संख्या

    कनेक्शन का आइडेंटिफ़ायर.

  • गड़बड़ी

    ReceiveError

    गड़बड़ी का कोड, जिससे पता चलता है कि क्या गड़बड़ी हुई.

ReceiveInfo

प्रॉपर्टी

  • connectionId

    संख्या

    कनेक्शन का आइडेंटिफ़ायर.

  • डेटा

    ArrayBuffer

    डेटा मिल गया है.

SendError

Enum

"disconnected"
कनेक्शन डिसकनेक्ट हो गया था.

"pending"
पहले से ही कोई अनुरोध मंज़ूरी के लिए बाकी है.

"timeout"
मैसेज भेजने की समयसीमा खत्म हो गई है.

"system_error"
सिस्टम में कोई गड़बड़ी हुई है और हो सकता है कि कनेक्शन को वापस न पाया जा सके.

SendInfo

प्रॉपर्टी

  • bytesSent

    संख्या

    भेजे गए बाइट की संख्या.

  • गड़बड़ी

    SendError ज़रूरी नहीं

    कोई गड़बड़ी होने पर, गड़बड़ी का कोड.

StopBits

Enum

"one"

"दो"

तरीके

clearBreak()

Promise Chrome 45 और इसके बाद के वर्शन 
chrome.serial.clearBreak(
  connectionId: number,
  callback?: function,
): Promise<boolean>

किसी कनेक्शन पर वर्ण ट्रांसमिशन को वापस चालू करना और ट्रांसमिशन लाइन को नॉन-ब्रेक स्टेट में रखना.

पैरामीटर

  • connectionId

    संख्या

    कनेक्शन का आईडी.

  • कॉलबैक

    function ज़रूरी नहीं

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (result: boolean) => void

    • नतीजा

      बूलियन

रिटर्न

  • Promise<boolean>

    Chrome 117 या इसके बाद का वर्शन

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म के लिए, कॉलबैक का इस्तेमाल करना ज़रूरी है.

connect()

वादा 
chrome.serial.connect(
  path: string,
  options?: ConnectionOptions,
  callback?: function,
): Promise<ConnectionInfo>

यह किसी सीरियल पोर्ट से कनेक्ट करता है.

पैरामीटर

  • पाथ

    स्ट्रिंग

    सीरियल पोर्ट का सिस्टम पाथ, जिसे खोलना है.

  • विकल्प

    ConnectionOptions ज़रूरी नहीं

    पोर्ट कॉन्फ़िगरेशन के विकल्प.

  • कॉलबैक

    function ज़रूरी नहीं

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (connectionInfo: ConnectionInfo) => void

रिटर्न

  • Promise<ConnectionInfo>

    Chrome 117 या इसके बाद का वर्शन

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म के लिए, कॉलबैक का इस्तेमाल करना ज़रूरी है.

disconnect()

वादा 
chrome.serial.disconnect(
  connectionId: number,
  callback?: function,
): Promise<boolean>

सीरियल पोर्ट से डिसकनेक्ट करता है.

पैरामीटर

  • connectionId

    संख्या

    खोले गए कनेक्शन का आईडी.

  • कॉलबैक

    function ज़रूरी नहीं

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (result: boolean) => void

    • नतीजा

      बूलियन

रिटर्न

  • Promise<boolean>

    Chrome 117 या इसके बाद का वर्शन

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म के लिए, कॉलबैक का इस्तेमाल करना ज़रूरी है.

flush()

वादा 
chrome.serial.flush(
  connectionId: number,
  callback?: function,
): Promise<boolean>

दिए गए कनेक्शन के इनपुट और आउटपुट बफ़र में मौजूद सभी बाइट को फ़्लश करता है.

पैरामीटर

  • connectionId

    संख्या

  • कॉलबैक

    function ज़रूरी नहीं

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (result: boolean) => void

    • नतीजा

      बूलियन

रिटर्न

  • Promise<boolean>

    Chrome 117 या इसके बाद का वर्शन

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म के लिए, कॉलबैक का इस्तेमाल करना ज़रूरी है.

getConnections()

वादा 
chrome.serial.getConnections(
  callback?: function,
): Promise<ConnectionInfo[]>

ऐप्लिकेशन के मालिकाना हक वाले, फ़िलहाल खुले हुए सीरियल पोर्ट कनेक्शन की सूची को वापस लाता है.

पैरामीटर

  • कॉलबैक

    function ज़रूरी नहीं

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (connectionInfos: ConnectionInfo[]) => void

रिटर्न

  • Promise<ConnectionInfo[]>

    Chrome 117 या इसके बाद का वर्शन

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म के लिए, कॉलबैक का इस्तेमाल करना ज़रूरी है.

getControlSignals()

वादा 
chrome.serial.getControlSignals(
  connectionId: number,
  callback?: function,
): Promise<DeviceControlSignals>

किसी कनेक्शन पर कंट्रोल सिग्नल की स्थिति की जानकारी हासिल करता है.

पैरामीटर

  • connectionId

    संख्या

    कनेक्शन का आईडी.

  • कॉलबैक

    function ज़रूरी नहीं

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (signals: DeviceControlSignals) => void

रिटर्न

  • Chrome 117 या इसके बाद का वर्शन

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म के लिए, कॉलबैक का इस्तेमाल करना ज़रूरी है.

getDevices()

वादा 
chrome.serial.getDevices(
  callback?: function,
): Promise<DeviceInfo[]>

सिस्टम पर उपलब्ध सीरियल डिवाइसों के बारे में जानकारी दिखाता है. इस तरीके को कॉल करने पर, हर बार सूची फिर से जनरेट होती है.

पैरामीटर

  • कॉलबैक

    function ज़रूरी नहीं

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (ports: DeviceInfo[]) => void

रिटर्न

  • Promise<DeviceInfo[]>

    Chrome 117 या इसके बाद का वर्शन

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म के लिए, कॉलबैक का इस्तेमाल करना ज़रूरी है.

getInfo()

वादा 
chrome.serial.getInfo(
  connectionId: number,
  callback?: function,
): Promise<ConnectionInfo>

यह किसी कनेक्शन की स्थिति की जानकारी देता है.

पैरामीटर

  • connectionId

    संख्या

    खोले गए कनेक्शन का आईडी.

  • कॉलबैक

    function ज़रूरी नहीं

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (connectionInfo: ConnectionInfo) => void

रिटर्न

  • Promise<ConnectionInfo>

    Chrome 117 या इसके बाद का वर्शन

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म के लिए, कॉलबैक का इस्तेमाल करना ज़रूरी है.

send()

वादा 
chrome.serial.send(
  connectionId: number,
  data: ArrayBuffer,
  callback?: function,
): Promise<SendInfo>

दिए गए कनेक्शन में डेटा सेव करता है.

पैरामीटर

  • connectionId

    संख्या

    कनेक्शन का आईडी.

  • डेटा

    ArrayBuffer

    भेजा जाने वाला डेटा.

  • कॉलबैक

    function ज़रूरी नहीं

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (sendInfo: SendInfo) => void

रिटर्न

  • Promise<SendInfo>

    Chrome 117 या इसके बाद का वर्शन

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म के लिए, कॉलबैक का इस्तेमाल करना ज़रूरी है.

setBreak()

Promise Chrome 45 और इसके बाद के वर्शन 
chrome.serial.setBreak(
  connectionId: number,
  callback?: function,
): Promise<boolean>

यह किसी कनेक्शन पर वर्ण ट्रांसमिशन को निलंबित कर देता है. साथ ही, ट्रांसमिशन लाइन को तब तक ब्रेक स्टेट में रखता है, जब तक clearBreak को कॉल नहीं किया जाता.

पैरामीटर

  • connectionId

    संख्या

    कनेक्शन का आईडी.

  • कॉलबैक

    function ज़रूरी नहीं

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (result: boolean) => void

    • नतीजा

      बूलियन

रिटर्न

  • Promise<boolean>

    Chrome 117 या इसके बाद का वर्शन

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म के लिए, कॉलबैक का इस्तेमाल करना ज़रूरी है.

setControlSignals()

वादा 
chrome.serial.setControlSignals(
  connectionId: number,
  signals: HostControlSignals,
  callback?: function,
): Promise<boolean>

यह नीति, किसी कनेक्शन पर कंट्रोल सिग्नल की स्थिति सेट करती है.

पैरामीटर

  • connectionId

    संख्या

    कनेक्शन का आईडी.

  • सिग्नल

    HostControlSignals

    डिवाइस पर भेजे जाने वाले सिग्नल में किए गए बदलावों का सेट.

  • कॉलबैक

    function ज़रूरी नहीं

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (result: boolean) => void

    • नतीजा

      बूलियन

रिटर्न

  • Promise<boolean>

    Chrome 117 या इसके बाद का वर्शन

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म के लिए, कॉलबैक का इस्तेमाल करना ज़रूरी है.

setPaused()

वादा 
chrome.serial.setPaused(
  connectionId: number,
  paused: boolean,
  callback?: function,
): Promise<void>

यह किसी ओपन कनेक्शन को रोकता है या फिर से शुरू करता है.

पैरामीटर

  • connectionId

    संख्या

    खोले गए कनेक्शन का आईडी.

  • रोका गया

    बूलियन

    इस फ़्लैग से पता चलता है कि वीडियो को रोकना है या फिर से चलाना है.

  • कॉलबैक

    function ज़रूरी नहीं

    callback पैरामीटर कुछ ऐसा दिखता है: 

    () => void

रिटर्न

  • वादा<शून्य>

    Chrome 117 या इसके बाद का वर्शन

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म के लिए, कॉलबैक का इस्तेमाल करना ज़रूरी है.

update()

वादा 
chrome.serial.update(
  connectionId: number,
  options: ConnectionOptions,
  callback?: function,
): Promise<boolean>

खुले हुए सीरियल पोर्ट कनेक्शन पर, विकल्प की सेटिंग अपडेट करें.

पैरामीटर

  • connectionId

    संख्या

    खोले गए कनेक्शन का आईडी.

  • विकल्प

    ConnectionOptions

    पोर्ट कॉन्फ़िगरेशन के विकल्प.

  • कॉलबैक

    function ज़रूरी नहीं

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (result: boolean) => void

    • नतीजा

      बूलियन

रिटर्न

  • Promise<boolean>

    Chrome 117 या इसके बाद का वर्शन

    प्रॉमिस सिर्फ़ Manifest V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म के लिए, कॉलबैक का इस्तेमाल करना ज़रूरी है.

इवेंट

onReceive

chrome.serial.onReceive.addListener(
  callback: function,
)

कनेक्शन से डेटा पढ़े जाने पर ट्रिगर होने वाला इवेंट.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (info: ReceiveInfo) => void

onReceiveError

chrome.serial.onReceiveError.addListener(
  callback: function,
)

यह इवेंट तब ट्रिगर होता है, जब सीरियल पोर्ट पर डेटा के लिए रनटाइम के इंतज़ार के दौरान कोई गड़बड़ी होती है. यह इवेंट होने के बाद, कनेक्शन को paused पर सेट किया जा सकता है. "timeout" गड़बड़ी होने पर, कनेक्शन नहीं रुकता.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (info: ReceiveErrorInfo) => void