Differences

This shows you the differences between two versions of the page.

--- logicpython:cubloc_api:opencom [2026/04/10 02:06] – created - external edit 127.0.0.1
+++ logicpython:cubloc_api:opencom [2026/04/14 04:47] (current) – removed mfranklin
@@ Line 1: / Line 1: @@
-====== OpenCom ======
-Enable serial communication on a CUBLOC-style ''channel''.
-===== Syntax =====
-<code python>
-from cubloc import OpenCom
-OpenCom(channel: int, baudRate: int, protocol: int, recvSize: int, sendSize: int)
-</code>
-===== Parameters =====
-  * **channel**: RS-232 ''channel'' number. ''Channel'' 0 maps to UART0 (GP0/GP1) and ''channel'' 1 maps to UART1 (GP4/GP5).
-  * **baudRate**: Serial baud rate. The documentation allows values between 2400 and 230400.
-  * **protocol**: Bit-packed serial format. Bit 2 selects one or two stop bits. Bits 1..0 select 5, 6, 7, or 8 data bits. Bits 4..3 select parity where 00 is none, 10 is even, and 11 is odd.
-  * **recvSize**: Receive buffer size in bytes. Maximum documented value is 1024.
-  * **sendSize**: Send buffer size in bytes. Maximum documented value is 1024.
-===== Exceptions =====
-  * [[https://docs.micropython.org/en/latest/library/builtins.html#TypeError|TypeError]]: One of the arguments is not an integer.
-  * [[https://docs.micropython.org/en/latest/library/builtins.html#ValueError|ValueError]]: The supplied values are outside the documented range.
-===== Example =====
-<code python>
-from cubloc import OpenCom
-# Example usage
-OpenCom(0, 1, 1, 1, 1)
-</code>
-===== Related APIs =====
-  * [[logicpython:cubloc_api:bclr|BClr]]
-  * [[logicpython:cubloc_api:bfree|BFree]]
-  * [[logicpython:cubloc_api:blen|BLen]]
-  * [[logicpython:cubloc_api:checkbf|CheckBf]]
-  * [[logicpython:cubloc_api:get|Get]]

User Tools

Site Tools

Differences

Page Tools