enigma_web 1.0.0

EnigmaWeb #

This library is conversion of EnigmaWeb to Dart language. Works with both Enigma1 and Enigma2 web interfaces.

First thing to do is to setup profile information

var profile = Profile();
profile.address = "192.168.0.2";
profile.httpPort = 80;
profile.enigma = EnigmaType.enigma2;
profile.username = "root";
profile.password = "password";

Execute command #

All available web commands are implemented, just execute command and read response from object model, ie.

//initialize parser to parse response to read current service from receiver
var currentServiceResponseParser = GetCurrentServiceParser();
//initialize http client implementation to send HTTP requests to receiver
var webRequester = WebRequester(Logger.root);
//initialize get current service command object
var command = GetCurrentServiceCommand(currentServiceResponseParser, webRequester);
//execute command and get typed result
GetCurrentServiceResponse response = await command.executeAsync(profile);
//use result
print(response.currentService);
print(response.responseDuration);

//some commands dont need parsing (IE. we're not interested in result, just if command was successfull)
//for that we use UnparsedParser<TCommand>, for example WakeUp command to wake up Enigma
var noParsing = UnparsedParser<WakeUpCommand>();
// perform WakeUp command, and just wait for it to finish
await WakeUpCommand(noParsing, requester).executeAsync(profile);

Changelog #

1.0.0 production ready

0.9.7 updated AltHttp package reference

0.9.6 removed canceltoken parameter

0.9.5 webrequest fixes for Enigma1

0.9.4 Optional retry strategy

0.9.3 Refactor as immutable types

0.9.2 Failed HTTP status code as int

0.9.1 Refactor command parameters

0.9.0 Uri encoding/decoding as E2 bug workaround

0.8.0 fixed bouquet items parser

0.7.0 all custom exceptions inherit from KnownException

0.6.0 added proxy as optional WebRequester parameter

0.5.0 code styling

0.4.0 absolute imports, equality operator, removed Factory

0.3.0 use curly braces for all flow control structures

0.2.0 minor code refactoring

0.1.0 first working conversion of EnigmaWeb to Dart language.

example/readme.md

EnigmaWeb #

This library is conversion of EnigmaWeb to Dart language. Works with both Enigma1 and Enigma2 web interfaces.

First thing to do is to setup profile information

var profile = Profile();
profile.address = "192.168.0.2";
profile.httpPort = 80;
profile.enigma = EnigmaType.enigma2;
profile.username = "root";
profile.password = "password";

Execute command #

All available web commands are implemented, just execute command and read response from object model, ie.

//initialize parser to parse response to read current service from receiver
var currentServiceResponseParser = GetCurrentServiceParser();
//initialize http client implementation to send HTTP requests to receiver
var webRequester = WebRequester(Logger.root);
//initialize get current service command object
var command = GetCurrentServiceCommand(currentServiceResponseParser, webRequester);
//execute command and get typed result
GetCurrentServiceResponse response = await command.executeAsync(profile);
//use result
print(response.currentService);
print(response.responseDuration);

//some commands dont need parsing (IE. we're not interested in result, just if command was successfull)
//for that we use UnparsedParser<TCommand>, for example WakeUp command to wake up Enigma
var noParsing = UnparsedParser<WakeUpCommand>();
// perform WakeUp command, and just wait for it to finish
await WakeUpCommand(noParsing, requester).executeAsync(profile);

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  enigma_web: ^1.0.0

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:enigma_web/enigma_web.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
41
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
70
Learn more about scoring.

We analyzed this package on Sep 13, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.5.0
  • pana: 0.12.21

Platforms

Detected platforms: Flutter, other

Primary library: package:enigma_web/enigma_web.dart with components: io.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.5.0 <3.0.0
alt_http ^0.2.0 0.2.0
cookie_jar ^1.0.0 1.0.1
dio ^2.1.5 2.1.16
logging ^0.11.3+2 0.11.3+2
test ^1.5.1+1 1.6.9
xml ^3.4.0 3.5.0
Transitive dependencies
analyzer 0.38.2
args 1.5.2
async 2.3.0
boolean_selector 1.0.5
charcode 1.1.2
collection 1.14.12
convert 2.1.1
crypto 2.1.3
csslib 0.16.1
front_end 0.1.24
glob 1.1.7
html 0.14.0+2
http 0.12.0+2
http_multi_server 2.1.0
http_parser 3.1.3
io 0.3.3
js 0.6.1+1
kernel 0.3.24
matcher 0.12.5
meta 1.1.7
mime 0.9.6+3
multi_server_socket 1.0.2
node_preamble 1.4.8
package_config 1.1.0
package_resolver 1.0.10
path 1.6.4
pedantic 1.8.0+1
petitparser 2.4.0
pool 1.4.0
pub_semver 1.4.2
shelf 0.7.5
shelf_packages_handler 1.0.4
shelf_static 0.2.8
shelf_web_socket 0.2.3
source_map_stack_trace 1.1.5
source_maps 0.10.8
source_span 1.5.5
stack_trace 1.9.3
stream_channel 2.0.0
string_scanner 1.0.5
term_glyph 1.1.0
test_api 0.2.7
test_core 0.2.9
typed_data 1.1.6
vm_service 1.2.0
watcher 0.9.7+12
web_socket_channel 1.0.15
yaml 2.1.16