chrome.serial

ब्यौरा

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

अनुमतियां

serial

उपलब्धता

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

टाइप

ConnectionInfo

प्रॉपर्टी

  • बिटरेट

    number ज़रूरी नहीं

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

  • bufferSize

    संख्या

    ConnectionOptions.bufferSize देखें

  • connectionId

    संख्या

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

  • ctsFlowControl

    boolean optional

    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

    boolean optional

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

  • dataBits

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

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

  • नाम

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

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

  • parityBit

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

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

  • अनवरत

    boolean optional

    यह फ़्लैग बताता है कि ऐप्लिकेशन के निलंबित होने पर कनेक्शन खुला रहना चाहिए या नहीं. इसके बारे में ज़्यादा जानने के लिए, ऐप्लिकेशन का लाइफ़साइकल मैनेज करना लेख पढ़ें. डिफ़ॉल्ट वैल्यू "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

    boolean optional

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

  • rts

    boolean optional

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

ParityBit

Enum

"no"

"odd"

"even"

ReceiveError

Enum

"डिसकनेक्ट किया गया"
कनेक्शन डिसकनेक्ट कर दिया गया है.

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

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

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

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

"ओवररन"
वर्ण-बफ़र ओवररन हुआ है. अगला वर्ण मिट जाता है.

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

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

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

ReceiveErrorInfo

प्रॉपर्टी

  • connectionId

    संख्या

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

  • गड़बड़ी

    ReceiveError

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

ReceiveInfo

प्रॉपर्टी

  • connectionId

    संख्या

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

  • डेटा

    ArrayBuffer

    डेटा मिला.

SendError

Enum

"डिसकनेक्ट किया गया"
कनेक्शन डिसकनेक्ट कर दिया गया है.

"pending"
भेजने का अनुरोध पहले से ही लंबित है.

"timeout"
भेजने का अनुरोध टाइम आउट हो गया.

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

SendInfo

प्रॉपर्टी

  • bytesSent

    संख्या

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

  • गड़बड़ी

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

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

StopBits

Enum

"one"

"two"

तरीके

clearBreak()

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

किसी कनेक्शन पर वर्ण ट्रांसफ़र करने की सुविधा को वापस चालू करता है और ट्रांसफ़र लाइन को नॉनब्रेक स्थिति में रखता है.

पैरामीटर

  • connectionId

    संख्या

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

  • कॉलबैक

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

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

    (result: boolean) => void

    • नतीजा

      बूलियन

रिटर्न

  • Promise<boolean>

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

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

connect()

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

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

पैरामीटर

  • पाथ

    स्ट्रिंग

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

  • विकल्प

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

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

  • कॉलबैक

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

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

    (connectionInfo: ConnectionInfo) => void

रिटर्न

  • Promise<ConnectionInfo>

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

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

disconnect()

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

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

पैरामीटर

  • connectionId

    संख्या

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

  • कॉलबैक

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

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

    (result: boolean) => void

    • नतीजा

      बूलियन

रिटर्न

  • Promise<boolean>

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

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

flush()

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

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

पैरामीटर

  • connectionId

    संख्या

  • कॉलबैक

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

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

    (result: boolean) => void

    • नतीजा

      बूलियन

रिटर्न

  • Promise<boolean>

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

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

getConnections()

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

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

पैरामीटर

  • कॉलबैक

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

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

    (connectionInfos: ConnectionInfo[]) => void

रिटर्न

  • Promise<ConnectionInfo[]>

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

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

getControlSignals()

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

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

पैरामीटर

  • connectionId

    संख्या

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

  • कॉलबैक

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

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

    (signals: DeviceControlSignals) => void

रिटर्न

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

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

getDevices()

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

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

पैरामीटर

  • कॉलबैक

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

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

    (ports: DeviceInfo[]) => void

रिटर्न

  • Promise<DeviceInfo[]>

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

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

getInfo()

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

यह फ़ंक्शन, दिए गए कनेक्शन की स्थिति को वापस लाता है.

पैरामीटर

  • connectionId

    संख्या

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

  • कॉलबैक

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

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

    (connectionInfo: ConnectionInfo) => void

रिटर्न

  • Promise<ConnectionInfo>

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

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

send()

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

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

पैरामीटर

  • connectionId

    संख्या

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

  • डेटा

    ArrayBuffer

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

  • कॉलबैक

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

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

    (sendInfo: SendInfo) => void

रिटर्न

  • Promise<SendInfo>

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

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

setBreak()

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

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

पैरामीटर

  • connectionId

    संख्या

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

  • कॉलबैक

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

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

    (result: boolean) => void

    • नतीजा

      बूलियन

रिटर्न

  • Promise<boolean>

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

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

setControlSignals()

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

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

पैरामीटर

  • connectionId

    संख्या

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

  • सिग्नल

    HostControlSignals

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

  • कॉलबैक

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

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

    (result: boolean) => void

    • नतीजा

      बूलियन

रिटर्न

  • Promise<boolean>

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

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

setPaused()

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

यह फ़ंक्शन, खुले हुए कनेक्शन को रोकता है या उसे फिर से शुरू करता है.

पैरामीटर

  • connectionId

    संख्या

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

  • रोका गया

    बूलियन

    यह फ़्लैग बताता है कि वीडियो को रोकना है या फिर से शुरू करना है.

  • कॉलबैक

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

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

    () => void

रिटर्न

  • Promise<void>

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

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

update()

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

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

पैरामीटर

  • connectionId

    संख्या

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

  • विकल्प

    ConnectionOptions

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

  • कॉलबैक

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

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

    (result: boolean) => void

    • नतीजा

      बूलियन

रिटर्न

  • 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