Skip to content

Commit 2e5ebc3

Browse files
giulcioffigiulcioffi
committed
Rename Camera APIs using camelCase Arduino standard
1 parent e1c1cfa commit 2e5ebc3

File tree

7 files changed

+92
-92
lines changed

7 files changed

+92
-92
lines changed

‎libraries/Camera/examples/CameraCaptureRawBytes/CameraCaptureRawBytes.ino‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ void blinkLED(uint32_t count = 0xFFFFFFFF)
3333
}
3434
}
3535

36-
void setup() {
36+
void setup() {
3737
// Init the cam QVGA, 30FPS
3838
if (!cam.begin(CAMERA_R320x240, IMAGE_MODE, 30)) {
3939
blinkLED();
@@ -57,8 +57,8 @@ void loop() {
5757
lastUpdate = millis();
5858

5959
// Grab frame and write to serial
60-
if (cam.GrabFrame(fb, 3000) == 0) {
61-
Serial.write(fb.getBuffer(), cam.FrameSize());
60+
if (cam.grabFrame(fb, 3000) == 0) {
61+
Serial.write(fb.getBuffer(), cam.frameSize());
6262
} else {
6363
blinkLED(20);
6464
}

‎libraries/Camera/src/camera.cpp‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,7 @@ Camera::Camera(ImageSensor &sensor) :
364364
{
365365
}
366366

367-
int Camera::Reset()
367+
int Camera::reset()
368368
{
369369
#ifdef ARDUINO_PORTENTA_H7_M7
370370
// Reset sensor.
@@ -377,7 +377,7 @@ int Camera::Reset()
377377
return 0;
378378
}
379379

380-
int Camera::ProbeSensor()
380+
int Camera::probeSensor()
381381
{
382382
uint8_t addr;
383383

@@ -405,22 +405,22 @@ bool Camera::begin(int32_t resolution, int32_t pixformat, int32_t framerate)
405405
HAL_Delay(10);
406406

407407
// Reset the image sensor.
408-
Reset();
408+
reset();
409409

410-
if (sensor->GetClockFrequency() != DCMI_TIM_FREQUENCY) {
410+
if (sensor->getClockFrequency() != DCMI_TIM_FREQUENCY) {
411411
// Reconfigure the sensor clock frequency.
412-
camera_extclk_config(sensor->GetClockFrequency());
412+
camera_extclk_config(sensor->getClockFrequency());
413413
HAL_Delay(10);
414414
}
415415

416-
if (this->sensor->Init() != 0) {
416+
if (this->sensor->init() != 0) {
417417
return false;
418418
}
419419

420-
if (ProbeSensor() != this->sensor->GetID()) {
420+
if (probeSensor() != this->sensor->getID()) {
421421
if (_debug) {
422422
_debug->print("Detected SensorID: 0x");
423-
_debug->println(this->sensor->GetID(), HEX);
423+
_debug->println(this->sensor->getID(), HEX);
424424
}
425425
return false;
426426
}
@@ -431,45 +431,45 @@ bool Camera::begin(int32_t resolution, int32_t pixformat, int32_t framerate)
431431

432432
// NOTE: The pixel format must be set first before the resolution,
433433
// to lookup the BPP for this format to set the DCMI cropping.
434-
if (SetPixelFormat(pixformat) != 0) {
434+
if (setPixelFormat(pixformat) != 0) {
435435
return false;
436436
}
437437

438-
if (SetResolution(resolution) != 0) {
438+
if (setResolution(resolution) != 0) {
439439
return false;
440440
}
441441

442-
if (SetFrameRate(framerate) != 0) {
442+
if (setFrameRate(framerate) != 0) {
443443
return false;
444444
}
445445

446446
return true;
447447
}
448448

449-
int Camera::GetID()
449+
int Camera::getID()
450450
{
451451
if (this->sensor == NULL) {
452452
return -1;
453453
}
454454

455-
return this->sensor->GetID();
455+
return this->sensor->getID();
456456
}
457457

458-
int Camera::SetFrameRate(int32_t framerate)
458+
int Camera::setFrameRate(int32_t framerate)
459459
{
460460
if (this->sensor == NULL) {
461461
return -1;
462462
}
463463

464-
if (this->sensor->SetFrameRate(framerate) == 0) {
464+
if (this->sensor->setFrameRate(framerate) == 0) {
465465
this->framerate = framerate;
466466
return 0;
467467
}
468468

469469
return -1;
470470
}
471471

472-
int Camera::SetResolution(int32_t resolution)
472+
int Camera::setResolution(int32_t resolution)
473473
{
474474
if (this->sensor == NULL || resolution >= CAMERA_RMAX
475475
|| pixformat >= CAMERA_PMAX || pixformat == -1) {
@@ -486,45 +486,45 @@ int Camera::SetResolution(int32_t resolution)
486486
uint32_t bpl = restab[resolution][0] * pixtab[pixformat];
487487
HAL_DCMI_ConfigCROP(&hdcmi, 0, 0, bpl - 1, restab[resolution][1] - 1);
488488

489-
if (this->sensor->SetResolution(resolution) == 0) {
489+
if (this->sensor->setResolution(resolution) == 0) {
490490
this->resolution = resolution;
491491
return 0;
492492
}
493493
return -1;
494494
}
495495

496-
int Camera::SetPixelFormat(int32_t pixformat)
496+
int Camera::setPixelFormat(int32_t pixformat)
497497
{
498498
if (this->sensor == NULL || pixformat >= CAMERA_PMAX) {
499499
return -1;
500500
}
501501

502-
if (this->sensor->SetPixelFormat(pixformat) == 0) {
502+
if (this->sensor->setPixelFormat(pixformat) == 0) {
503503
this->pixformat = pixformat;
504504
return 0;
505505
}
506506
return -1;
507507
}
508508

509-
int Camera::SetStandby(bool enable)
509+
int Camera::setStandby(bool enable)
510510
{
511511
if (this->sensor == NULL) {
512512
return -1;
513513
}
514514

515-
return this->sensor->SetStandby(enable);
515+
return this->sensor->setStandby(enable);
516516
}
517517

518-
int Camera::SetTestPattern(bool enable, bool walking)
518+
int Camera::setTestPattern(bool enable, bool walking)
519519
{
520520
if (this->sensor == NULL) {
521521
return -1;
522522
}
523523

524-
return this->sensor->SetTestPattern(enable, walking);
524+
return this->sensor->setTestPattern(enable, walking);
525525
}
526526

527-
int Camera::FrameSize()
527+
int Camera::frameSize()
528528
{
529529
if (this->sensor == NULL
530530
|| this->pixformat == -1
@@ -535,15 +535,15 @@ int Camera::FrameSize()
535535
return restab[this->resolution][0] * restab[this->resolution][1] * pixtab[this->pixformat];
536536
}
537537

538-
int Camera::GrabFrame(FrameBuffer &fb, uint32_t timeout)
538+
int Camera::grabFrame(FrameBuffer &fb, uint32_t timeout)
539539
{
540540
if (this->sensor == NULL
541541
|| this->pixformat == -1
542542
|| this->resolution == -1) {
543543
return -1;
544544
}
545545

546-
uint32_t framesize = FrameSize();
546+
uint32_t framesize = frameSize();
547547

548548
if (fb.isAllocated()) {
549549
//A buffer has already been allocated

‎libraries/Camera/src/camera.h‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -62,26 +62,26 @@ class FrameBuffer {
6262
class ImageSensor {
6363
public:
6464
virtual ~ImageSensor() { }
65-
virtual int Init() = 0;
66-
virtual int Reset() = 0;
67-
virtual int GetID() = 0;
68-
virtual uint32_t GetClockFrequency() = 0;
69-
virtual int SetFrameRate(int32_t framerate) = 0;
70-
virtual int SetResolution(int32_t resolution) = 0;
71-
virtual int SetPixelFormat(int32_t pixelformat) = 0;
65+
virtual int init() = 0;
66+
virtual int reset() = 0;
67+
virtual int getID() = 0;
68+
virtual uint32_t getClockFrequency() = 0;
69+
virtual int setFrameRate(int32_t framerate) = 0;
70+
virtual int setResolution(int32_t resolution) = 0;
71+
virtual int setPixelFormat(int32_t pixelformat) = 0;
7272
virtual int reg_write(uint8_t dev_addr, uint16_t reg_addr, uint8_t reg_data, bool wide_addr) = 0;
7373
virtual uint8_t reg_read(uint8_t dev_addr, uint16_t reg_addr, bool wide_addr) = 0;
7474
virtual void debug(Stream &stream) = 0;
7575

76-
int SetStandby(bool enable) {
76+
int setStandby(bool enable) {
7777
return -1;
7878
}
7979

8080
int IOCTL(int request, ...) {
8181
return -1;
8282
}
8383

84-
int SetTestPattern(bool enable, bool walking) {
84+
int setTestPattern(bool enable, bool walking) {
8585
return -1;
8686
}
8787
};
@@ -92,22 +92,22 @@ class Camera {
9292
int32_t resolution;
9393
int32_t framerate;
9494
ImageSensor *sensor;
95-
int Reset();
96-
int ProbeSensor();
95+
int reset();
96+
int probeSensor();
9797
Stream *_debug;
9898
arduino::MbedI2C *_i2c;
9999
FrameBuffer *_framebuffer;
100100
public:
101101
Camera(ImageSensor &sensor);
102102
bool begin(int32_t resolution=CAMERA_R320x240, int32_t pixformat=CAMERA_GRAYSCALE, int32_t framerate=30);
103-
int GetID();
104-
int SetFrameRate(int32_t framerate);
105-
int SetResolution(int32_t resolution);
106-
int SetPixelFormat(int32_t pixelformat);
107-
int SetStandby(bool enable);
108-
int SetTestPattern(bool enable, bool walking);
109-
int FrameSize();
110-
int GrabFrame(FrameBuffer &fb, uint32_t timeout=5000);
103+
int getID();
104+
int setFrameRate(int32_t framerate);
105+
int setResolution(int32_t resolution);
106+
int setPixelFormat(int32_t pixelformat);
107+
int setStandby(bool enable);
108+
int setTestPattern(bool enable, bool walking);
109+
int frameSize();
110+
int grabFrame(FrameBuffer &fb, uint32_t timeout=5000);
111111
void debug(Stream &stream);
112112
};
113113

‎libraries/GC2145/gc2145.cpp‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -712,7 +712,7 @@ GC2145::GC2145(arduino::MbedI2C &i2c) :
712712
{
713713
}
714714

715-
int GC2145::Init()
715+
int GC2145::init()
716716
{
717717
_i2c->begin();
718718
_i2c->setClock(100000);
@@ -727,7 +727,7 @@ int GC2145::Init()
727727
return ret;
728728
}
729729

730-
int GC2145::SetWindow(uint16_t reg, uint16_t x, uint16_t y, uint16_t w, uint16_t h)
730+
int GC2145::setWindow(uint16_t reg, uint16_t x, uint16_t y, uint16_t w, uint16_t h)
731731
{
732732
int ret = 0;
733733

@@ -753,17 +753,17 @@ int GC2145::SetWindow(uint16_t reg, uint16_t x, uint16_t y, uint16_t w, uint16_t
753753
return ret;
754754
}
755755

756-
int GC2145::Reset()
756+
int GC2145::reset()
757757
{
758758
return 0;
759759
}
760760

761-
int GC2145::SetFrameRate(int32_t framerate)
761+
int GC2145::setFrameRate(int32_t framerate)
762762
{
763763
return 0;
764764
}
765765

766-
int GC2145::SetResolution(int32_t resolution)
766+
int GC2145::setResolution(int32_t resolution)
767767
{
768768
int ret = 0;
769769

@@ -807,10 +807,10 @@ int GC2145::SetResolution(int32_t resolution)
807807
uint16_t win_y = ((GC_MAX_WIN_H - win_h) / 2);
808808

809809
// Set readout window first.
810-
ret |= SetWindow(0x09, win_x, win_y, win_w + 16, win_h + 8);
810+
ret |= setWindow(0x09, win_x, win_y, win_w + 16, win_h + 8);
811811

812812
// Set cropping window next.
813-
ret |= SetWindow(0x91, x, y, w, h);
813+
ret |= setWindow(0x91, x, y, w, h);
814814

815815
// Enable crop
816816
ret |= reg_write(GC2145_I2C_ADDR, 0x90, 0x01);
@@ -823,7 +823,7 @@ int GC2145::SetResolution(int32_t resolution)
823823

824824
}
825825

826-
int GC2145::SetPixelFormat(int32_t pixformat)
826+
int GC2145::setPixelFormat(int32_t pixformat)
827827
{
828828
int ret = 0;
829829
uint8_t reg;

‎libraries/GC2145/gc2145.h‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,19 @@
2323

2424
class GC2145: public ImageSensor {
2525
private:
26-
int SetWindow(uint16_t reg, uint16_t x, uint16_t y, uint16_t w, uint16_t h);
26+
int setWindow(uint16_t reg, uint16_t x, uint16_t y, uint16_t w, uint16_t h);
2727
Stream *_debug;
2828
arduino::MbedI2C *_i2c;
2929

3030
public:
3131
GC2145(arduino::MbedI2C &i2c = CameraWire);
32-
int Init();
33-
int Reset();
34-
int GetID() { return GC2145_I2C_ADDR; };
35-
uint32_t GetClockFrequency() { return 12000000; };
36-
int SetFrameRate(int32_t framerate);
37-
int SetResolution(int32_t resolution);
38-
int SetPixelFormat(int32_t pixformat);
32+
int init();
33+
int reset();
34+
int getID() { return GC2145_I2C_ADDR; };
35+
uint32_t getClockFrequency() { return 12000000; };
36+
int setFrameRate(int32_t framerate);
37+
int setResolution(int32_t resolution);
38+
int setPixelFormat(int32_t pixformat);
3939
int reg_write(uint8_t dev_addr, uint16_t reg_addr, uint8_t reg_data, bool wide_addr = false);
4040
uint8_t reg_read(uint8_t dev_addr, uint16_t reg_addr, bool wide_addr = false);
4141
void debug(Stream &stream);

0 commit comments

Comments
 (0)