summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLGetDTCs.h
blob: 2ba8339d58b562403073713731bc118706b6be39 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
//  SDLGetDTCs.h
//


#import "SDLRPCRequest.h"

/**
 * This RPC allows to request diagnostic module trouble codes from a certain
 * vehicle module
 * <p>
 * Function Group: ProprietaryData
 * <p>
 * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
 * <p>
 */

NS_ASSUME_NONNULL_BEGIN

@interface SDLGetDTCs : SDLRPCRequest

/// Convenience init
///
/// @param name Name of the module to receive the DTC form
/// @return An SDLGetDTCs object
- (instancetype)initWithECUName:(UInt16)name;

/// Convenience init with all properties
///
/// @param name Name of the module to receive the DTC form
/// @param mask DTC Mask Byte to be sent in diagnostic request to module
/// @return An SDLGetDTCs object
- (instancetype)initWithECUName:(UInt16)name mask:(UInt8)mask;

/**
 * a name of the module to receive the DTC form
 * @discussion an NSNumber value representing a name of the module to receive
 *            the DTC form
 *            <p>
 *            <b>Notes: </b>Minvalue:0; Maxvalue:65535
 */
@property (strong, nonatomic) NSNumber<SDLInt> *ecuName;
/**
 *  DTC Mask Byte to be sent in diagnostic request to module. NSNumber* dtcMask Minvalue:0; Maxvalue:255
 */
@property (nullable, strong, nonatomic) NSNumber<SDLInt> *dtcMask;
@end

NS_ASSUME_NONNULL_END