ioBroker.duofern

Tests:

DuoFern Adapter for ioBroker

Connect Rademacher DuoFern devices via DuoFern USB Stick.

Installation

1. Install the adapter through ioBroker Admin interface
2. Configure the serial port and stick code
3. Start the adapter

Configuration

Serial Port

Specify the path to the serial port where your DuoFern USB stick is connected:

• Linux: /dev/ttyUSB0 or /dev/serial/by-id/...
• Windows: COM1, COM2, etc.

Example: /dev/serial/by-id/usb-Rademacher_DuoFern_USB-Stick_WR03XXXX-if00-port0

Tip: On Linux, it is highly recommended to use the path in /dev/serial/by-id/ instead of /dev/ttyUSB0, as it is persistent and more stable across reboots. Use ls -l /dev/serial/by-id/ to find the correct path.

DuoFern Stick Code

Enter the 6-digit hexadecimal code of your DuoFern stick:

• Must start with 6F
• Last 4 digits are freely configurable (e.g., 6F1234)

Supported Devices

• Blinds/Roller Shutters: Basic control (up, down, stop, position, other commands may work, but untested)
  • Note: Currently, this adapter is only tested with blinds/roller shutters.

Usage

1. Put devices into pairing mode using the pair button in the adapter
2. Activate pairing mode on your DuoFern device (see device manual)
3. The device should appear automatically in the object tree
4. Control devices through the created states

Troubleshooting

Device not found

• Check serial port path and permissions
• Verify stick code is correct
• Ensure USB stick is properly connected

Device not responding

• Check if device is within radio range
• Verify device is properly paired
• Check adapter logs for error messages

Acknowledgements

• FHEM: This adapter is inspired by the DuoFern module for FHEM. For more details on the DuoFern module, refer to the FHEM Wiki.

Development

Contributing

See CONTRIBUTING.md for detailed guidelines.

Best Practices

For general ioBroker development and coding best practices, refer to the ioBroker development guidelines.

Scripts in package.json

Several npm scripts are predefined for your convenience. Run them using npm run <scriptname>:

| Script name | Description | | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | | build | Compile TypeScript sources. | | watch | Compile TypeScript sources and watch for changes. | | test:ts | Execute unit tests in *.test.ts files. | | test:package | Validate package.json and io-package.json. | | test:integration | Test adapter startup with an actual ioBroker instance. | | test | Run unit tests and package validation. | | check | Perform type-check without compilation. | | coverage | Generate code coverage report. | | lint | Check code for formatting errors and potential bugs using ESLint. | | format | Format code using Prettier. | | translate | Translate texts to all required languages. See @iobroker/adapter-dev. | | release | Create a new release. See @alcalzone/release-script. | | dev-server | Start ioBroker development server for testing. |

Testing

The project includes comprehensive unit tests with code coverage reporting:

# Run tests
npm test

# Run tests with coverage report
npm run coverage

The project maintains high code coverage standards with automated checks enforced through CI/CD pipelines.

Continuous Integration

The project uses GitHub Actions for automated testing and quality checks:

• Test Workflow: Runs on every pull request to the main branch
• Coverage Validation: Enforces minimum coverage thresholds for statements, branches, and functions
• Build Verification: Ensures TypeScript compilation succeeds

All pull requests must pass these automated checks before merging.

Changelog

0.7.1 (2025-12-26)

• (glaessep) Uncommented deploy section in test-and-release workflow for npm releases
• (glaessep) Updated repository URL format in package.json
• (glaessep) Removed obsolete test workflow configuration
• (glaessep) Updated README for logo display and correct section title casing
• (glaessep) Fixed DuoFern title casing for all languages
• (glaessep) Added placeholder configuration to release settings
• (glaessep) Re-added prepare script to ensure build runs before other scripts
• (glaessep) Updated build script to fallback to TypeScript compiler if build-adapter fails
• (glaessep) Removed .npmignore file (files are managed in package.json)
• (glaessep) Formatted ESLint, Mocha, and TypeScript configuration files for consistency

0.7.0 (2025-12-25)

• (glaessep) Migrated to ioBroker adapter creator v3 structure
• (glaessep) Improved testability with SerialPort dependency injection
• (glaessep) Enhanced coverage reporting to include json-summary format
• (glaessep) Updated documentation and translation files
• (glaessep) Fixed file references and dependencies
• (glaessep) Updated .gitignore to include log and commitinfo files
• (glaessep) Removed redundant keyword from io-package.json

0.6.4 (2024-12-25)

• (glaessep) Added GitHub workflow for automated test and coverage checks
• (glaessep) Improved parameter visualization in adapter settings
• (glaessep) Enhanced documentation

License

MIT License

Copyright (c) 2025 Patrick Gläßer [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.