Skip to content

README.md

Latest commit

 

History

History
79 lines (58 loc) · 2.09 KB

README.md

File metadata and controls

79 lines (58 loc) · 2.09 KB

Serial Port Communication for Nodepp Applications

nodepp-serial is a powerful and easy-to-use library that brings robust serial port communication capabilities to your Nodepp applications. Leveraging Nodepp's asynchronous architecture, nodepp-serial allows you to interact with serial devices seamlessly, making it ideal for IoT, embedded systems, and hardware control projects developed with Nodepp.

Dependencies & Cmake Integration

include(FetchContent)

FetchContent_Declare(
	nodepp
	GIT_REPOSITORY   https://github.com/NodeppOfficial/nodepp
	GIT_TAG          origin/main
	GIT_PROGRESS     ON
)
FetchContent_MakeAvailable(nodepp)

FetchContent_Declare(
	nodepp-serial
	GIT_REPOSITORY   https://github.com/NodeppOfficial/nodepp-serial
	GIT_TAG          origin/main
	GIT_PROGRESS     ON
)
FetchContent_MakeAvailable(nodepp-serial)

#[...]

target_link_libraries( #[...]
	PUBLIC nodepp nodepp-serial #[...]
)

Key Features:

  • Asynchronous Operations: Fully integrated with Nodepp's event loop for non-blocking serial port access.
  • Cross-Platform: Designed to work across various operating systems supported by Nodepp.
  • Simple API: An intuitive and Node.js-like API for opening, closing, reading from, and writing to serial ports.
  • Event-Driven: Emits events for data reception, errors, and port status changes, simplifying event handling.

Example

#include <nodepp/nodepp.h>
#include <serial/serial.h>

using namespace nodepp;

void onMain(){

    seria.scan()

    .then([=]( ptr_t<string_t> paths ){

        auto sr = serial::connect( device[0], 9600 ).await();
        if( !st.has_value() ){ 
            throw except_t( "invalid serial device" );
        }

        console::done( "connected" );

        cli.onData([]( string_t chunk ){
            console::log( chunk );
        });

        stream::pipe( cli );

    })

    .fail([=]( except_t err ){
        console::log( err.what() );
    });

}

Compilation

g++ -o main main.cpp -I ./include ; ./main

License

Nodepp-Serial is distributed under the MIT License. See the LICENSE file for more details.