Merge pull request #132 from dynamsoft-docs/preview

update to internal commit 7c36394c

Author: DMGithubPublisher

programming/cplusplus/index.md

@@ -36,6 +36,11 @@ The best way to start with the Dynamsoft Barcode Reader C++ Edition, is followin
 
 - MacOS 64bit: 10.12+ (not included in the trial package, contact us to get the SDK)
 
+- For Embedded Devices:
+For embedded or ARM-based platforms, we recommend using a device with performance equivalent to or better than a Raspberry Pi 4 Model B (4GB RAM). Minimum recommended specs:
+  - Quad-core ARM Cortex-A72 processor (or equivalent)
+  - 4 GB RAM
+  - Linux-based OS (e.g., Raspberry Pi OS, Ubuntu Server)
 
 ## License Subscription
 

programming/cplusplus/upgrade-instruction.md

@@ -147,22 +147,22 @@ public:
 
 int main()
 {
-    CCaptureVisionRouter *cvr = new CCaptureVisionRouter;
+    CCaptureVisionRouter *cvRouter = new CCaptureVisionRouter;
 
     // Create your video source and bind it to the router
     MyVideoSource *source = new MyVideoSource;
-    cvr->SetInput(source);
+    cvRouter->SetInput(source);
 
     // Create a CCapturedResultReceiver instance 
     MyBarcodeResultReceiver *barcodesReceiver = new MyCapturedResultReceiver;
-    cvr->AddResultReceiver(barcodesReceiver);
+    cvRouter->AddResultReceiver(barcodesReceiver);
 
     // Start capturing
-    errorCode = cvr->StartCapturing(CPresetTemplate::PT_READ_BARCODES, true, errorMsg, 512);
+    errorCode = cvRouter->StartCapturing(CPresetTemplate::PT_READ_BARCODES, true, errorMsg, 512);
 
     delete barcodesReceiver;
     delete source;
-    delete cvr;
+    delete cvRouter;
 }
 ```
 

programming/cplusplus/user-guide.md

@@ -96,7 +96,7 @@ CLicenseManager::InitLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", errorMs
 Create an instance of Capture Vision Router.
 
 ```cpp
-CCaptureVisionRouter* cvr = new CCaptureVisionRouter;
+CCaptureVisionRouter* cvRouter = new CCaptureVisionRouter;
 ```
 
 ### Decode and Output Results
@@ -105,7 +105,7 @@ Decode barcodes from an image file.
 
 ```cpp
 string imageFile = "[PATH-TO-A-BARCODE-IMAGE]";
-CCapturedResult* result = cvr->Capture(imageFile.c_str(), CPresetTemplate::PT_READ_BARCODES);
+CCapturedResult* result = cvRouter->Capture(imageFile.c_str(), CPresetTemplate::PT_READ_BARCODES);
 if (result->GetErrorCode() != 0) {
     cout << "Error: " << result->GetErrorCode() << "," << result->GetErrorString() << endl;
 }
@@ -138,7 +138,7 @@ else
 if (barcodeResult)
     barcodeResult->Release();
 result->Release();
-delete cvr, cvr = NULL;
+delete cvRouter, cvRouter = NULL;
 ```
 
 ### Build and Run the Project
@@ -208,7 +208,7 @@ Set up a `CDirectoryFetcher` object to retrieve image data sources from a direct
 ```cpp
 CDirectoryFetcher *fetcher = new CDirectoryFetcher;
 fetcher->SetDirectory("[THE DIRECTORY THAT HOLDS THE IMAGES]");
-cvr->SetInput(fetcher);
+cvRouter->SetInput(fetcher);
 ```
 
 ### Add a Result Receiver as the Output
@@ -247,7 +247,7 @@ Create and register a `MyCapturedResultReceiver` object as the result receiver.
 
 ```cpp
 CCapturedResultReceiver *capturedReceiver = new MyCapturedResultReceiver;
-cvr->AddResultReceiver(capturedReceiver);
+cvRouter->AddResultReceiver(capturedReceiver);
 ```
 
 ### Add an Object to Listen to the Status of the Image Source
@@ -273,24 +273,24 @@ public:
 Create and register a `MyImageSourceStateListener` object as the listener.
 
 ```cpp
-CImageSourceStateListener *listener = new MyImageSourceStateListener(cvr);
-cvr->AddImageSourceStateListener(listener);
+CImageSourceStateListener *listener = new MyImageSourceStateListener(cvRouter);
+cvRouter->AddImageSourceStateListener(listener);
 ```
 
 ### Start the Process
 
 Call the method `StartCapturing()` to start processing all the images in the specified folder.
 
 ```cpp
-int errorCode = cvr->StartCapturing(CPresetTemplate::PT_READ_BARCODES, true, errorMsg, 512);        
+int errorCode = cvRouter->StartCapturing(CPresetTemplate::PT_READ_BARCODES, true, errorMsg, 512);        
 ```
 
 During the process, the callback function `OnDecodedBarcodesReceived()` is triggered each time an image finishes processing. After all images are processed, the listener function `OnImageSourceStateReceived()` will return the image source state as `ISS_EXHAUSTED` and the process is stopped with the method `StopCapturing()`.
 
 ### Release the Allocated Memory
 
 ```cpp
-delete cvr, cvr = NULL;
+delete cvRouter, cvRouter = NULL;
 delete fetcher, fetcher = NULL;
 delete listener, listener = NULL;
 delete capturedReceiver, capturedReceiver = NULL;

programming/dotnet/user-guide.md

@@ -92,7 +92,7 @@ if (errorCode != (int)EnumErrorCode.EC_OK && errorCode != (int)EnumErrorCode.EC_
 ### Create a CaptureVisionRouter Instance
 
 ```csharp
-using (CaptureVisionRouter cvr = new CaptureVisionRouter())
+using (CaptureVisionRouter cvRouter = new CaptureVisionRouter())
 {
     //code for invoking the barcode capturing
 }
@@ -101,10 +101,10 @@ using (CaptureVisionRouter cvr = new CaptureVisionRouter())
 ### Invoke the Barcode Capturing
 
 ```csharp
-using (CaptureVisionRouter cvr = new CaptureVisionRouter())
+using (CaptureVisionRouter cvRouter = new CaptureVisionRouter())
 {
     string imageFile = "[PATH-TO-THE-IMAGE-FILE]";
-    CapturedResult? result = cvr.Capture(imageFile, PresetTemplate.PT_READ_BARCODES);
+    CapturedResult? result = cvRouter.Capture(imageFile, PresetTemplate.PT_READ_BARCODES);
     //code for filtering and getting barcode details
 }
 ```
@@ -218,18 +218,18 @@ Create a class `MyImageSourceStateListener` to implement the `IImageSourceStateL
 ```csharp
 class MyImageSourceStateListener : IImageSourceStateListener
 {
-    private CaptureVisionRouter? cvr = null;
-    public MyImageSourceStateListener(CaptureVisionRouter cvr)
+    private CaptureVisionRouter? cvRouter = null;
+    public MyImageSourceStateListener(CaptureVisionRouter cvRouter)
     {
-        this.cvr = cvr;
+        this.cvRouter = cvRouter;
     }
     public void OnImageSourceStateReceived(EnumImageSourceState state)
     {
         if (state == EnumImageSourceState.ISS_EXHAUSTED)
         {
-            if (cvr != null)
+            if (cvRouter != null)
             {
-                cvr.StopCapturing();
+                cvRouter.StopCapturing();
             }
         }
     }
@@ -239,19 +239,19 @@ class MyImageSourceStateListener : IImageSourceStateListener
 ### Register the Input, Output Listener and ImageSource State Listener to the CaptureVisionRouter Instance
 
 ```csharp
-cvr.SetInput(fetcher);
+cvRouter.SetInput(fetcher);
 CapturedResultReceiver receiver = new MyCapturedResultReceiver();
-cvr.AddResultReceiver(receiver);
-MyImageSourceStateListener listener = new MyImageSourceStateListener(cvr);
-cvr.AddImageSourceStateListener(listener);
+cvRouter.AddResultReceiver(receiver);
+MyImageSourceStateListener listener = new MyImageSourceStateListener(cvRouter);
+cvRouter.AddImageSourceStateListener(listener);
 ```
 
 ### Start the Capturing Process
 
 Call the method `StartCapturing()` to start processing all the images in the specified folder.
 
 ```csharp
-errorCode = cvr.StartCapturing(PresetTemplate.PT_READ_BARCODES, true, out errorMsg);
+errorCode = cvRouter.StartCapturing(PresetTemplate.PT_READ_BARCODES, true, out errorMsg);
 if (errorCode != (int)EnumErrorCode.EC_OK)
 {
     Console.WriteLine("error: " + errorMsg);

programming/python/index.md

@@ -38,6 +38,12 @@ The best way to start with the Dynamsoft Barcode Reader Python Edition, is follo
   - Python 3.5 (for versions below DBR 7.5)
   - Python 2.7 (for versions below DBR 7.2.2.3)
 
+- For Embedded Devices:
+For embedded or ARM-based platforms, we recommend using a device with performance equivalent to or better than a Raspberry Pi 4 Model B (4GB RAM). Minimum recommended specs:
+  - Quad-core ARM Cortex-A72 processor (or equivalent)
+  - 4 GB RAM
+  - Linux-based OS (e.g., Raspberry Pi OS, Ubuntu Server)
+
 ## API Reference
 
 For an overview of the APIs, see the [API Reference]({{ site.dbr_python_api }}).

programming/python/user-guide.md

@@ -80,13 +80,13 @@ else:
 ### Create a CaptureVisionRouter Instance
 
 ```python
-cvr = CaptureVisionRouter()
+cvr_instance = CaptureVisionRouter()
 ```
 
 ### Invoke the Barcode Capturing
 
 ```python
-result = cvr.capture("[PATH-TO-THE-IMAGE-FILE]", EnumPresetTemplate.PT_READ_BARCODES.value)
+result = cvr_instance.capture("[PATH-TO-THE-IMAGE-FILE]", EnumPresetTemplate.PT_READ_BARCODES.value)
 ```
 
 > Please change the `[PATH-TO-THE-IMAGE-FILE]` to a real barcode image file path.
@@ -181,31 +181,31 @@ Create a class `MyImageSourceStateListener` to implement the `ImageSourceStateLi
 
 ```python
 class MyImageSourceStateListener(ImageSourceStateListener):
-    def __init__(self, cvr:CaptureVisionRouter) -> None:
+    def __init__(self, cvr_instance:CaptureVisionRouter) -> None:
         super().__init__()
-        self.cvr = cvr
+        self.cvr_instance = cvr_instance
     def on_image_source_state_received(self, state: int) -> None:
         if state == EnumImageSourceState.ISS_EXHAUSTED:
-            if self.cvr != None:
-                self.cvr.stop_capturing()
+            if self.cvr_instance != None:
+                self.cvr_instance.stop_capturing()
 ```
 
 ### Register the Input, Output Listener and ImageSource State Listener to the CaptureVisionRouter Instance
 
 ```python
-cvr.set_input(fetcher)
+cvr_instance.set_input(fetcher)
 receiver = MyCapturedResultReceiver()
-cvr.add_result_receiver(receiver)
-listener = MyImageSourceStateListener(cvr)
-cvr.add_image_source_state_listener(listener)
+cvr_instance.add_result_receiver(receiver)
+listener = MyImageSourceStateListener(cvr_instance)
+cvr_instance.add_image_source_state_listener(listener)
 ```
 
 ### Start the Capturing Process
 
 Call the method `start_capturing()` to start processing all the images in the specified folder.
 
 ```python
-errorCode, errorMsg = cvr.start_capturing("", True)
+errorCode, errorMsg = cvr_instance.start_capturing("", True)
 if errorCode != EnumErrorCode.EC_OK:
     print("error:", errorMsg)
 ```