Skip to content

Commit

Permalink
DOCS-2400: Add snippets for resource base methods (#231)
Browse files Browse the repository at this point in the history
  • Loading branch information
JessamyT authored Jun 14, 2024
1 parent 6185ee4 commit e5a7063
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions lib/src/resource/base.dart
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,22 @@ class Subtype {
const Subtype(this.namespace, this.resourceType, this.resourceSubtype);

/// Create a new [Subtype] from a [ResourceName]
///
/// ```
/// // Example, creating a Sensor from a resource named "mySensor":
/// var mySensor = Sensor.fromResourceName('mySensor');
/// ```
Subtype.fromResourceName(ResourceName name)
: namespace = name.namespace,
resourceType = name.type,
resourceSubtype = name.subtype;

/// Get a [ResourceName] from this [Subtype] and a provided [name]
///
/// ```
/// // Example, getting the ResourceName of a sensor named "my_sensor":
/// var resourceName = Sensor.getResourceName('my_sensor');
/// ```
ResourceName getResourceName(String name) {
return ResourceName()
..namespace = namespace
Expand All @@ -56,6 +66,12 @@ abstract class Resource {
abstract final String name;

/// Send/Receive arbitrary commands to the [Resource]
///
/// ```
/// // Example using doCommand with an arm component
/// const command = {'cmd': 'test', 'data1': 500};
/// var result = myArm.doCommand(command);
/// ```
Future<Map<String, dynamic>> doCommand(Map<String, dynamic> command) {
throw UnimplementedError();
}
Expand Down

0 comments on commit e5a7063

Please sign in to comment.