chrome.serial

ब्यौरा

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

अनुमतियां

serial

टाइप

ConnectionInfo

प्रॉपर्टी

  • बिटरेट

    नंबर ज़रूरी नहीं

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

  • bufferSize

    नंबर

    ConnectionOptions.bufferSize देखें

  • connectionId

    नंबर

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

  • ctsFlowControl

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

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

  • dataBits

    DataBits ज़रूरी नहीं है

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

  • नाम

    स्ट्रिंग

    ConnectionOptions.name देखें

  • parityBit

    ParityBit ज़रूरी नहीं है

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

  • रोका गया

    boolean

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

  • अनवरत

    boolean

    ConnectionOptions.persistent देखें

  • receiveTimeout

    नंबर

    ConnectionOptions.receiveTimeout देखें

  • sendTimeout

    नंबर

    ConnectionOptions.sendTimeout देखें

  • stopBits

    StopBits ज़रूरी नहीं है

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

ConnectionOptions

प्रॉपर्टी

  • बिटरेट

    नंबर ज़रूरी नहीं

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

  • bufferSize

    नंबर ज़रूरी नहीं

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

  • ctsFlowControl

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

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

  • dataBits

    DataBits ज़रूरी नहीं है

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

  • नाम

    स्ट्रिंग ज़रूरी नहीं

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

  • parityBit

    ParityBit ज़रूरी नहीं है

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

  • अनवरत

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

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

  • receiveTimeout

    नंबर ज़रूरी नहीं

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

  • sendTimeout

    नंबर ज़रूरी नहीं

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

  • stopBits

    StopBits ज़रूरी नहीं है

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

DataBits

Enum

DeviceControlSignals

प्रॉपर्टी

  • cts

    boolean

    सीटीएस (भेजने के लिए हटाएं).

  • घटिया

    boolean

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

  • डीएसआर

    boolean

    DSR (डेटा सेट तैयार).

  • ri

    boolean

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

DeviceInfo

प्रॉपर्टी

  • displayName

    स्ट्रिंग ज़रूरी नहीं

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

  • पाथ

    स्ट्रिंग

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

  • productId

    नंबर ज़रूरी नहीं

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

  • vendorId

    नंबर ज़रूरी नहीं

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

HostControlSignals

प्रॉपर्टी

  • डीटीआर

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

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

  • आरटी

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

    आरटीएस (अनुरोध भेजने का अनुरोध).

ParityBit

Enum

"odd"

ReceiveError

Enum

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

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

"device_lost"
शायद डिवाइस होस्ट से डिसकनेक्ट हो गया है.

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

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

"ओवररन"
वर्ण-बफ़र ओवररन हुआ है. इसके बाद, अगला वर्ण खो जाता है.

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

"parity_error"
डिवाइस पर समानता से जुड़ी गड़बड़ी का पता चला है.

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

ReceiveErrorInfo

प्रॉपर्टी

  • connectionId

    नंबर

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

  • गड़बड़ी

    ReceiveError

    गड़बड़ी दिखाने वाला गड़बड़ी कोड.

ReceiveInfo

प्रॉपर्टी

  • connectionId

    नंबर

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

  • डेटा

    ArrayBuffer

    डेटा मिला.

SendError

Enum

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

"pending"
भेजा जाना पहले से ही बाकी है.

"timeout"
भेजने का समय खत्म हुआ.

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

SendInfo

प्रॉपर्टी

  • bytesSent

    नंबर

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

  • गड़बड़ी

    SendError ज़रूरी नहीं

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

StopBits

Enum

तरीके

clearBreak()

प्रॉमिस Chrome 45+ 
chrome.serial.clearBreak(
  connectionId: number,
  callback?: function,
)

दिए गए कनेक्शन पर कैरेक्टर ट्रांसमिशन को रीस्टोर करें और ट्रांसमिशन लाइन को नॉनब्रेक स्थिति में रखें.

पैरामीटर

  • connectionId

    नंबर

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

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    (result: boolean)=>void

    • नतीजा

      boolean

रिटर्न

  • Promise<boolean>

    Chrome 117 और उसके बाद के वर्शन

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

connect()

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

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

पैरामीटर

  • पाथ

    स्ट्रिंग

    खोलने के लिए सीरियल पोर्ट का सिस्टम पाथ.

  • विकल्प

    ConnectionOptions ज़रूरी नहीं

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

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    (connectionInfo: ConnectionInfo)=>void

रिटर्न

  • Promise<ConnectionInfo>

    Chrome 117 और उसके बाद के वर्शन

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

disconnect()

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

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

पैरामीटर

  • connectionId

    नंबर

    खुले हुए कनेक्शन का आईडी.

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    (result: boolean)=>void

    • नतीजा

      boolean

रिटर्न

  • Promise<boolean>

    Chrome 117 और उसके बाद के वर्शन

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

flush()

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

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

पैरामीटर

  • connectionId

    नंबर

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    (result: boolean)=>void

    • नतीजा

      boolean

रिटर्न

  • Promise<boolean>

    Chrome 117 और उसके बाद के वर्शन

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

getConnections()

वादा 
chrome.serial.getConnections(
  callback?: function,
)

ऐप्लिकेशन के मालिकाना हक वाले मौजूदा सीरियल पोर्ट कनेक्शन की सूची वापस लाता है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    (connectionInfos: ConnectionInfo[])=>void

रिटर्न

  • Promise<ConnectionInfo[]>

    Chrome 117 और उसके बाद के वर्शन

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

getControlSignals()

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

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

पैरामीटर

  • connectionId

    नंबर

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

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    (signals: DeviceControlSignals)=>void

रिटर्न

  • Chrome 117 और उसके बाद के वर्शन

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

getDevices()

वादा 
chrome.serial.getDevices(
  callback?: function,
)

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

पैरामीटर

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    (ports: DeviceInfo[])=>void

रिटर्न

  • Promise<DeviceInfo[]>

    Chrome 117 और उसके बाद के वर्शन

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

getInfo()

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

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

पैरामीटर

  • connectionId

    नंबर

    खुले हुए कनेक्शन का आईडी.

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    (connectionInfo: ConnectionInfo)=>void

रिटर्न

  • Promise<ConnectionInfo>

    Chrome 117 और उसके बाद के वर्शन

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

send()

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

दिए गए कनेक्शन में डेटा लिखता है.

पैरामीटर

  • connectionId

    नंबर

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

  • डेटा

    ArrayBuffer

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

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    (sendInfo: SendInfo)=>void

रिटर्न

  • Promise<SendInfo>

    Chrome 117 और उसके बाद के वर्शन

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

setBreak()

प्रॉमिस Chrome 45+ 
chrome.serial.setBreak(
  connectionId: number,
  callback?: function,
)

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

पैरामीटर

  • connectionId

    नंबर

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

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    (result: boolean)=>void

    • नतीजा

      boolean

रिटर्न

  • Promise<boolean>

    Chrome 117 और उसके बाद के वर्शन

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

setControlSignals()

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

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

पैरामीटर

  • connectionId

    नंबर

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

  • सिग्नल

    HostControlSignals

    डिवाइस पर भेजे जाने वाले सिग्नल का सेट बदल जाता है.

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    (result: boolean)=>void

    • नतीजा

      boolean

रिटर्न

  • Promise<boolean>

    Chrome 117 और उसके बाद के वर्शन

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

setPaused()

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

ओपन कनेक्शन को रोकता या चालू करता है.

पैरामीटर

  • connectionId

    नंबर

    खुले हुए कनेक्शन का आईडी.

  • रोका गया

    boolean

    रोकने या चालू करने के लिए फ़्लैग करें.

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    ()=>void

रिटर्न

  • Promise<void>

    Chrome 117 और उसके बाद के वर्शन

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

update()

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

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

पैरामीटर

  • connectionId

    नंबर

    खुले हुए कनेक्शन का आईडी.

  • विकल्प

    ConnectionOptions

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

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    (result: boolean)=>void

    • नतीजा

      boolean

रिटर्न

  • Promise<boolean>

    Chrome 117 और उसके बाद के वर्शन

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट 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