Download the PHP package rossel/mwu-sdk without Composer

On this page you can find all versions of the php package rossel/mwu-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of rossel/mwu-sdk

Informations about the package mwu-sdk

MWU SDK

MWU SDK is a PHP library for easy communication with the MWU Series product distributed by Pick to Light.

Compatibility

Pick to Light specifications

The following table shows the compatibility between MWU SDK versions and the implemented TCP-IP command references provided by Pick to Light.

MWU SDK version Implemented TCP-IP Command Reference
^1.0.0 6.1

Supported languages and frameworks

This library is compatible with vanilla PHP and provides a Symfony bundle for easier integration into your projects.

MWU SDK version PHP compatibility Symfony compatibility
^1.0.0 ^8.2 ^6.4

Getting started

Installation

To install the library in your PHP project, execute the following command:

Symfony integration

This library provides a Symfony bundle, which helps you to integrate this library to your project.
Once the composer package installed, execute the Symfony Flex recipe, or manually create a new mwu_sdk.yaml configuration file under the config/packages/ directory.

Here is an example configuration file you can use: config/packages/mwu_sdk.yaml.
Don't forget to change the "CHANGE_ME!" values :slightly_smiling_face: !

Once done, you're all set!

For more information about the configuration file, see Defining a default configuration

Manual integration

You'll have to instantiate manually the Rossel\MwuSdk\Client\Mwu\Mwu service.
Read the phpdoc for more information about dependencies to inject.

Overview of most used classes

Below is a class diagram illustrating the relationships between the main classes used in the MWU SDK.

yaml mwu_sdk: switches:

Explanation of lightModulesGeneratorConfig Parameters

The lightModulesGeneratorConfig parameters define an arithmetic sequence for generating light module identifiers. The identifiers are calculated as follows:

This configuration generates a sequence of identifiers starting from firstModuleId, where each subsequent module ID is incremented by incrementBetweenModuleIds up to the total count specified in numberOfModules.

Behavior Configuration Parameters

Each parameter in the mwu_sdk behavior configuration is detailed below, specifying possible values, type, default values, and descriptions.

display_status.light.mode

Controls the light's operational mode.

Parameter Type Possible Values Required Default
mode string "on", "off", "flash", "fast_flash" ✖️ "on"

display_status.light.color

Sets the color of the light.

Parameter Type Possible Values Required Default
color string "white", "red", "green", "blue", "cyan", "magenta", "yellow" ✖️ "white"

display_status.screen.mode

Controls the screen's operational mode.

Parameter Type Possible Values Required Default
mode string "on", "off", "flash", "fast_flash" ✖️ "on"

display_status.screen.text

Displays a custom 4-character string on screen.

Parameter Type Possible Values Required Default
text string Any 4-character string ✖️ "----"

display_status_after_confirm.light.mode

Controls the light's operational mode after confirmation.

Parameter Type Possible Values Required Default
mode string "on", "off", "flash", "fast_flash" ✖️ "on"

display_status_after_confirm.light.color

Sets the color of the light after confirmation.

Parameter Type Possible Values Required Default
color string "white", "red", "green", "blue", "cyan", "magenta", "yellow" ✖️ "white"

display_status_after_confirm.screen.mode

Controls the screen's operational mode after confirmation.

Parameter Type Possible Values Required Default
mode string "on", "off", "flash", "fast_flash" ✖️ "on"

display_status_after_confirm.screen.text

Displays a custom 4-character string on the screen after confirmation.

Parameter Type Possible Values Required Default
text string Any 4-character string ✖️ "----"

display_status_after_fn.light.mode

Controls the light's operational mode after "fn" action.

Parameter Type Possible Values Required Default
mode string "on", "off", "flash", "fast_flash" ✖️ "on"

display_status_after_fn.light.color

Sets the color of the light after "fn" action.

Parameter Type Possible Values Required Default
color string "white", "red", "green", "blue", "cyan", "magenta", "yellow" ✖️ "white"

display_status_after_fn.screen.mode

Controls the screen's operational mode after "fn" action.

Parameter Type Possible Values Required Default
mode string "on", "off", "flash", "fast_flash" ✖️ "on"

display_status_after_fn.screen.text

Displays a custom 4-character string on screen after "fn" action.

Parameter Type Possible Values Required Default
text string Any 4-character string ✖️ "----"

buttons.fn.text

Custom text shown on "fn" button display.

Parameter Type Possible Values Required Default
text string Any 4-character string ✖️ "----"

buttons.quantity_keys.mode

Sets behavior for the quantity keys.

Parameter Type Possible Values Required Default
mode string "increment", "revise", "off" ✖️ "increment"

Sending a Command

This section outlines the process of sending commands within the MWU system. Commands can be issued from switches, light modules, or the MWU service, allowing flexible control over the system's operations.

Write command

The write command allows you to send text or data instructions to individual or multiple light modules within the MWU system. It provides configuration options to customize the light's appearance, such as color and display mode, facilitating communication and signaling in pick-to-light applications.

Write text on an individual light module

Write text on multiple light modules, from a specific switch

Write text on light modules of multiple switches

All versions of mwu-sdk with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
symfony/validator Version ^6.4
symfony/yaml Version ^6.4
symfony/options-resolver Version ^6.4
ext-sockets Version ^8.2
symfony/dependency-injection Version ^6.4
symfony/http-kernel Version ^6.4
symfony/config Version ^6.4
symfony/process Version ^6.4
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package rossel/mwu-sdk contains the following files

Loading the files please wait ....